R4 Ballot #1 (Mixed Normative/Trial use)
TerminologyThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Vocabulary Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for expansionprofile
{
"resourceType": "StructureDefinition",
"id": "ExpansionProfile",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "vocab"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ExpansionProfile",
"name": "ExpansionProfile",
"status": "draft",
"date": "2018-04-03T12:05:46+10:00",
"publisher": "Health Level Seven International (Vocabulary)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}
]
}
],
"description": "Resource to define constraints on the Expansion of a FHIR ValueSet.",
"fhirVersion": "3.3.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "ExpansionProfile",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ExpansionProfile",
"path": "ExpansionProfile",
"short": "Defines behavior and constraints on the ValueSet Expansion operation",
"definition": "Resource to define constraints on the Expansion of a FHIR ValueSet.",
"alias": [
"ValueSetExpansionProfile"
],
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.id",
"path": "ExpansionProfile.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.meta",
"path": "ExpansionProfile.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.implicitRules",
"path": "ExpansionProfile.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "ExpansionProfile.language",
"path": "ExpansionProfile.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.text",
"path": "ExpansionProfile.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ExpansionProfile.contained",
"path": "ExpansionProfile.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.extension",
"path": "ExpansionProfile.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.modifierExtension",
"path": "ExpansionProfile.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.url",
"path": "ExpansionProfile.url",
"short": "Canonical identifier for this expansion profile, represented as a URI (globally unique)",
"definition": "An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this expansion profile is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the expansion profile to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "ExpansionProfile.identifier",
"path": "ExpansionProfile.identifier",
"short": "Additional identifier for the expansion profile",
"definition": "A formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this expansion profile outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExpansionProfile.version",
"path": "ExpansionProfile.version",
"short": "Business version of the expansion profile",
"definition": "The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different expansion profile instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the expansion profile with the format [url]|[version].",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "ExpansionProfile.name",
"path": "ExpansionProfile.name",
"short": "Name for this expansion profile (computer friendly)",
"definition": "A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.status",
"path": "ExpansionProfile.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this expansion profile. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of expansion profiles that are appropriate for use versus not.",
"min": 1,
"max": "1",
"base": {
"path": "ExpansionProfile.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "ExpansionProfile.experimental",
"path": "ExpansionProfile.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of expansion profiles that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level expansion profile.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "ExpansionProfile.date",
"path": "ExpansionProfile.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the expansion profile was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the expansion profile changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the expansion profile. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "ExpansionProfile.publisher",
"path": "ExpansionProfile.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the expansion profile.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the expansion profile is the organization or individual primarily responsible for the maintenance and upkeep of the expansion profile. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the expansion profile. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the expansion profile. May also allow for contact.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "ExpansionProfile.contact",
"path": "ExpansionProfile.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ExpansionProfile.description",
"path": "ExpansionProfile.description",
"short": "Natural language description of the expansion profile",
"definition": "A free text natural language description of the expansion profile from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the expansion profile was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the expansion profile as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "ExpansionProfile.useContext",
"path": "ExpansionProfile.useContext",
"short": "The context that the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ExpansionProfile.jurisdiction",
"path": "ExpansionProfile.jurisdiction",
"short": "Intended jurisdiction for expansion profile (if applicable)",
"definition": "A legal or geographic region in which the expansion profile is intended to be used.",
"comment": "It may be possible for the expansion profile to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ExpansionProfile.fixedVersion",
"path": "ExpansionProfile.fixedVersion",
"short": "Fix use of a code system to a particular version",
"definition": "Fix use of a particular code system to a particular version.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.fixedVersion",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.id",
"path": "ExpansionProfile.fixedVersion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.fixedVersion.extension",
"path": "ExpansionProfile.fixedVersion.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.fixedVersion.modifierExtension",
"path": "ExpansionProfile.fixedVersion.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.fixedVersion.system",
"path": "ExpansionProfile.fixedVersion.system",
"short": "System to have its version fixed",
"definition": "The specific system for which to fix the version.",
"comment": "See ''Coding.system'' for further documentation.",
"min": 1,
"max": "1",
"base": {
"path": "ExpansionProfile.fixedVersion.system",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.version",
"path": "ExpansionProfile.fixedVersion.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system from which codes in the expansion should be included.",
"min": 1,
"max": "1",
"base": {
"path": "ExpansionProfile.fixedVersion.version",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.mode",
"path": "ExpansionProfile.fixedVersion.mode",
"short": "default | check | override",
"definition": "How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.",
"min": 1,
"max": "1",
"base": {
"path": "ExpansionProfile.fixedVersion.mode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SystemVersionProcessingMode"
}
],
"strength": "required",
"description": "How to manage the intersection between a fixed version in a value set, and a fixed version of the system in the expansion profile",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/system-version-processing-mode"
}
},
{
"id": "ExpansionProfile.excludedSystem",
"path": "ExpansionProfile.excludedSystem",
"short": "Systems/Versions to be exclude",
"definition": "Code system, or a particular version of a code system to be excluded from value set expansions.",
"comment": "When a system is excluded, and this makes a material difference to the expansion, the exclusion SHALL be noted in the expansion parameters using a parameter 'excluded'.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.excludedSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.excludedSystem.id",
"path": "ExpansionProfile.excludedSystem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.excludedSystem.extension",
"path": "ExpansionProfile.excludedSystem.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.excludedSystem.modifierExtension",
"path": "ExpansionProfile.excludedSystem.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.excludedSystem.system",
"path": "ExpansionProfile.excludedSystem.system",
"short": "The specific code system to be excluded",
"definition": "An absolute URI which is the code system to be excluded.",
"comment": "See ''Coding.system'' for further documentation.",
"min": 1,
"max": "1",
"base": {
"path": "ExpansionProfile.excludedSystem.system",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.excludedSystem.version",
"path": "ExpansionProfile.excludedSystem.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system from which codes in the expansion should be excluded.",
"comment": "This is used to apply version specific exclusion constraints. If no version is specified, then all codes from the code system present in the expansion (prior to application of the expansion profile) will be excluded.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.excludedSystem.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"meaningWhenMissing": "Exclusion is not version specific",
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.includeDesignations",
"path": "ExpansionProfile.includeDesignations",
"short": "Whether the expansion should include concept designations",
"definition": "Controls whether concept designations are to be included or excluded in value set expansions.",
"comment": "ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are only evaluated if includeDesignations is present and set to \"true\". If includeDesignations is present with a value of \"true\" and both ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are absent, then all designations are returned in the expansion.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.includeDesignations",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation",
"path": "ExpansionProfile.designation",
"short": "When the expansion profile imposes designation constraints",
"definition": "A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation.id",
"path": "ExpansionProfile.designation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.extension",
"path": "ExpansionProfile.designation.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.modifierExtension",
"path": "ExpansionProfile.designation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.designation.include",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationInclude"
}
],
"path": "ExpansionProfile.designation.include",
"short": "Designations to be included",
"definition": "Designations to be included.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.include",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation.include.id",
"path": "ExpansionProfile.designation.include.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.include.extension",
"path": "ExpansionProfile.designation.include.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.include.modifierExtension",
"path": "ExpansionProfile.designation.include.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.designation.include.designation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationIncludeDesignation"
}
],
"path": "ExpansionProfile.designation.include.designation",
"short": "The designation to be included",
"definition": "A data group for each designation to be included.",
"comment": "At least one of designation.language or designation.use must be provided for each include.designation element.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.designation.include.designation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "exp-3",
"severity": "error",
"human": "SHALL have at least one of language or use",
"expression": "language.exists() or use.exists()",
"xpath": "exists(f:language) or exists(f:use)"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation.include.designation.id",
"path": "ExpansionProfile.designation.include.designation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.include.designation.extension",
"path": "ExpansionProfile.designation.include.designation.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.include.designation.modifierExtension",
"path": "ExpansionProfile.designation.include.designation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.designation.include.designation.language",
"path": "ExpansionProfile.designation.include.designation.language",
"short": "Human language of the designation to be included",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, all designations are retained which match the designation.use parameter for this include.designation.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.include.designation.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.designation.include.designation.use",
"path": "ExpansionProfile.designation.include.designation.use",
"short": "What kind of Designation to include",
"definition": "Which kinds of designation to include in the expansion.",
"comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this include.designation element.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.include.designation.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "required",
"description": "Details of how a designation would be used.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id": "ExpansionProfile.designation.exclude",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationExclude"
}
],
"path": "ExpansionProfile.designation.exclude",
"short": "Designations to be excluded",
"definition": "Designations to be excluded.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.exclude",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation.exclude.id",
"path": "ExpansionProfile.designation.exclude.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.extension",
"path": "ExpansionProfile.designation.exclude.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.modifierExtension",
"path": "ExpansionProfile.designation.exclude.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.designation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationExcludeDesignation"
}
],
"path": "ExpansionProfile.designation.exclude.designation",
"short": "The designation to be excluded",
"definition": "A data group for each designation to be excluded.",
"comment": "At least one of designation.language or designation.use must be provided for each exclude.designation element.",
"min": 0,
"max": "*",
"base": {
"path": "ExpansionProfile.designation.exclude.designation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "exp-4",
"severity": "error",
"human": "SHALL have at least one of language or use",
"expression": "language.exists() or use.exists()",
"xpath": "exists(f:language) or exists(f:use)"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.designation.exclude.designation.id",
"path": "ExpansionProfile.designation.exclude.designation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.designation.extension",
"path": "ExpansionProfile.designation.exclude.designation.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.designation.modifierExtension",
"path": "ExpansionProfile.designation.exclude.designation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.designation.exclude.designation.language",
"path": "ExpansionProfile.designation.exclude.designation.language",
"short": "Human language of the designation to be excluded",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, all designations are excluded which match the designation.use parameter for this exclude.designation element.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.exclude.designation.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.designation.exclude.designation.use",
"path": "ExpansionProfile.designation.exclude.designation.use",
"short": "What kind of Designation to exclude",
"definition": "Which kinds of designation to exclude from the expansion.",
"comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this exclude.designation element.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.designation.exclude.designation.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "required",
"description": "Details of how a designation would be used.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id": "ExpansionProfile.includeDefinition",
"path": "ExpansionProfile.includeDefinition",
"short": "Include or exclude the value set definition in the expansion",
"definition": "Controls whether the value set definition is included or excluded in value set expansions.",
"comment": "The ValueSet definition refers to all fields in the ValueSet definition apart from ValueSet.contains. The definition is only included if includeDefinition is present and has a value of \"true\".",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.includeDefinition",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "Definitions are only included if the value of this element is 'true'",
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.activeOnly",
"path": "ExpansionProfile.activeOnly",
"short": "Include or exclude inactive concepts in the expansion",
"definition": "Controls whether inactive concepts are included or excluded in value set expansions.",
"comment": "Only active codes are included if activeOnly is present and has a value of \"true\". Note that if the value set definition explicitly specifies that inactive codes are included, this property can still remove them from a particular expansion. This parameter cannot be used to include inactive codes (e.g. by setting activeOnly=false) if the value set definition excludes them.\n\nNote: Each terminology may define the statuses that they include, which determines which codes are considered to be 'active' in FHIR. For HL7 code systems 'deprecated' codes are considered to be 'active', whereas 'retired' codes are 'inactive'.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.activeOnly",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "If the activeOnly element is missing, the inclusion or exclusion of inactive codes is determined by the value set definition. If this is not specified in the value set definition the behavior is server dependent, but the usual expectation would be that inactive codes will not be included in the expansion",
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.excludeNested",
"path": "ExpansionProfile.excludeNested",
"short": "Nested codes in the expansion or not",
"definition": "Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).",
"comment": "Nesting of codes is excluded if excludeNested is present and has a value of \"true\".",
"requirements": "Heirahical contains are useful for UI use, but not when validating. Code Generation etc. may depend on context.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.excludeNested",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.excludeNotForUI",
"path": "ExpansionProfile.excludeNotForUI",
"short": "Include or exclude codes which cannot be rendered in user interfaces in the value set expansion",
"definition": "Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.",
"comment": "Codes which cannot be used in user interfaces will be excluded if excludeNotForUI is present and has a value of \"true\".",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.excludeNotForUI",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.excludePostCoordinated",
"path": "ExpansionProfile.excludePostCoordinated",
"short": "Include or exclude codes which are post coordinated expressions in the value set expansion",
"definition": "Controls whether or not the value set expansion includes post coordinated codes.",
"comment": "Post coordinated codes are excluded if excludePostCoordinated is present and has a value of \"true\".",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.excludePostCoordinated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "ExpansionProfile.displayLanguage",
"path": "ExpansionProfile.displayLanguage",
"short": "Specify the language for the display element of codes in the value set expansion",
"definition": "Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.displayLanguage",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.limitedExpansion",
"path": "ExpansionProfile.limitedExpansion",
"short": "Controls behavior of the value set expand operation when value sets are too large to be completely expanded",
"definition": "If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).",
"comment": "This field overrides the default behavior (which is to return an error). This does not apply to expansions which are unbounded. Clients SHALL process the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html) correctly if limitedExpansion = true.",
"min": 0,
"max": "1",
"base": {
"path": "ExpansionProfile.limitedExpansion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"id": "ExpansionProfile",
"path": "ExpansionProfile",
"short": "Defines behavior and constraints on the ValueSet Expansion operation",
"definition": "Resource to define constraints on the Expansion of a FHIR ValueSet.",
"alias": [
"ValueSetExpansionProfile"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ExpansionProfile.url",
"path": "ExpansionProfile.url",
"short": "Canonical identifier for this expansion profile, represented as a URI (globally unique)",
"definition": "An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which this expansion profile is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the expansion profile to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.url"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
}
]
},
{
"id": "ExpansionProfile.identifier",
"path": "ExpansionProfile.identifier",
"short": "Additional identifier for the expansion profile",
"definition": "A formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this expansion profile outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.identifier"
},
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ExpansionProfile.version",
"path": "ExpansionProfile.version",
"short": "Business version of the expansion profile",
"definition": "The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different expansion profile instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the expansion profile with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.version"
},
{
"identity": "w5",
"map": "FiveWs.version"
}
]
},
{
"id": "ExpansionProfile.name",
"path": "ExpansionProfile.name",
"short": "Name for this expansion profile (computer friendly)",
"definition": "A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.status",
"path": "ExpansionProfile.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this expansion profile. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of expansion profiles that are appropriate for use versus not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of an artifact.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.status"
},
{
"identity": "w5",
"map": "FiveWs.status"
}
]
},
{
"id": "ExpansionProfile.experimental",
"path": "ExpansionProfile.experimental",
"short": "For testing purposes, not real usage",
"definition": "A Boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.",
"comment": "Allows filtering of expansion profiles that are appropriate for use versus not.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level expansion profile.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.experimental"
},
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "ExpansionProfile.date",
"path": "ExpansionProfile.date",
"short": "Date last changed",
"definition": "The date (and optionally time) when the expansion profile was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the expansion profile changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the expansion profile. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.date"
},
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "ExpansionProfile.publisher",
"path": "ExpansionProfile.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the organization or individual that published the expansion profile.",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the expansion profile is the organization or individual primarily responsible for the maintenance and upkeep of the expansion profile. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the expansion profile. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the expansion profile. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.publisher"
},
{
"identity": "w5",
"map": "FiveWs.witness"
}
]
},
{
"id": "ExpansionProfile.contact",
"path": "ExpansionProfile.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.contact"
}
]
},
{
"id": "ExpansionProfile.description",
"path": "ExpansionProfile.description",
"short": "Natural language description of the expansion profile",
"definition": "A free text natural language description of the expansion profile from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the expansion profile was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the expansion profile as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Definition.description"
}
]
},
{
"id": "ExpansionProfile.useContext",
"path": "ExpansionProfile.useContext",
"short": "The context that the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Definition.useContext"
}
]
},
{
"id": "ExpansionProfile.jurisdiction",
"path": "ExpansionProfile.jurisdiction",
"short": "Intended jurisdiction for expansion profile (if applicable)",
"definition": "A legal or geographic region in which the expansion profile is intended to be used.",
"comment": "It may be possible for the expansion profile to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping": [
{
"identity": "workflow",
"map": "Definition.jurisdiction"
}
]
},
{
"id": "ExpansionProfile.fixedVersion",
"path": "ExpansionProfile.fixedVersion",
"short": "Fix use of a code system to a particular version",
"definition": "Fix use of a particular code system to a particular version.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.system",
"path": "ExpansionProfile.fixedVersion.system",
"short": "System to have its version fixed",
"definition": "The specific system for which to fix the version.",
"comment": "See ''Coding.system'' for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.version",
"path": "ExpansionProfile.fixedVersion.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system from which codes in the expansion should be included.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.fixedVersion.mode",
"path": "ExpansionProfile.fixedVersion.mode",
"short": "default | check | override",
"definition": "How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SystemVersionProcessingMode"
}
],
"strength": "required",
"description": "How to manage the intersection between a fixed version in a value set, and a fixed version of the system in the expansion profile",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/system-version-processing-mode"
}
},
{
"id": "ExpansionProfile.excludedSystem",
"path": "ExpansionProfile.excludedSystem",
"short": "Systems/Versions to be exclude",
"definition": "Code system, or a particular version of a code system to be excluded from value set expansions.",
"comment": "When a system is excluded, and this makes a material difference to the expansion, the exclusion SHALL be noted in the expansion parameters using a parameter 'excluded'.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.excludedSystem.system",
"path": "ExpansionProfile.excludedSystem.system",
"short": "The specific code system to be excluded",
"definition": "An absolute URI which is the code system to be excluded.",
"comment": "See ''Coding.system'' for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.excludedSystem.version",
"path": "ExpansionProfile.excludedSystem.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system from which codes in the expansion should be excluded.",
"comment": "This is used to apply version specific exclusion constraints. If no version is specified, then all codes from the code system present in the expansion (prior to application of the expansion profile) will be excluded.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"meaningWhenMissing": "Exclusion is not version specific",
"isSummary": true
},
{
"id": "ExpansionProfile.includeDesignations",
"path": "ExpansionProfile.includeDesignations",
"short": "Whether the expansion should include concept designations",
"definition": "Controls whether concept designations are to be included or excluded in value set expansions.",
"comment": "ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are only evaluated if includeDesignations is present and set to \"true\". If includeDesignations is present with a value of \"true\" and both ExpansionProfile.designation.include and ExpansionProfile.designation.exclude are absent, then all designations are returned in the expansion.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation",
"path": "ExpansionProfile.designation",
"short": "When the expansion profile imposes designation constraints",
"definition": "A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation.include",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationInclude"
}
],
"path": "ExpansionProfile.designation.include",
"short": "Designations to be included",
"definition": "Designations to be included.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation.include.designation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationIncludeDesignation"
}
],
"path": "ExpansionProfile.designation.include.designation",
"short": "The designation to be included",
"definition": "A data group for each designation to be included.",
"comment": "At least one of designation.language or designation.use must be provided for each include.designation element.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "exp-3",
"severity": "error",
"human": "SHALL have at least one of language or use",
"expression": "language.exists() or use.exists()",
"xpath": "exists(f:language) or exists(f:use)"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation.include.designation.language",
"path": "ExpansionProfile.designation.include.designation.language",
"short": "Human language of the designation to be included",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, all designations are retained which match the designation.use parameter for this include.designation.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.designation.include.designation.use",
"path": "ExpansionProfile.designation.include.designation.use",
"short": "What kind of Designation to include",
"definition": "Which kinds of designation to include in the expansion.",
"comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this include.designation element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "required",
"description": "Details of how a designation would be used.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id": "ExpansionProfile.designation.exclude",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationExclude"
}
],
"path": "ExpansionProfile.designation.exclude",
"short": "Designations to be excluded",
"definition": "Designations to be excluded.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation.exclude.designation",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "DesignationExcludeDesignation"
}
],
"path": "ExpansionProfile.designation.exclude.designation",
"short": "The designation to be excluded",
"definition": "A data group for each designation to be excluded.",
"comment": "At least one of designation.language or designation.use must be provided for each exclude.designation element.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "exp-4",
"severity": "error",
"human": "SHALL have at least one of language or use",
"expression": "language.exists() or use.exists()",
"xpath": "exists(f:language) or exists(f:use)"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.designation.exclude.designation.language",
"path": "ExpansionProfile.designation.exclude.designation.language",
"short": "Human language of the designation to be excluded",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, all designations are excluded which match the designation.use parameter for this exclude.designation element.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.designation.exclude.designation.use",
"path": "ExpansionProfile.designation.exclude.designation.use",
"short": "What kind of Designation to exclude",
"definition": "Which kinds of designation to exclude from the expansion.",
"comment": "In the absence of a use, all designations are retained which match the designation.language parameter for this exclude.designation element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "required",
"description": "Details of how a designation would be used.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/designation-use"
}
},
{
"id": "ExpansionProfile.includeDefinition",
"path": "ExpansionProfile.includeDefinition",
"short": "Include or exclude the value set definition in the expansion",
"definition": "Controls whether the value set definition is included or excluded in value set expansions.",
"comment": "The ValueSet definition refers to all fields in the ValueSet definition apart from ValueSet.contains. The definition is only included if includeDefinition is present and has a value of \"true\".",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "Definitions are only included if the value of this element is 'true'",
"isSummary": true
},
{
"id": "ExpansionProfile.activeOnly",
"path": "ExpansionProfile.activeOnly",
"short": "Include or exclude inactive concepts in the expansion",
"definition": "Controls whether inactive concepts are included or excluded in value set expansions.",
"comment": "Only active codes are included if activeOnly is present and has a value of \"true\". Note that if the value set definition explicitly specifies that inactive codes are included, this property can still remove them from a particular expansion. This parameter cannot be used to include inactive codes (e.g. by setting activeOnly=false) if the value set definition excludes them.\n\nNote: Each terminology may define the statuses that they include, which determines which codes are considered to be 'active' in FHIR. For HL7 code systems 'deprecated' codes are considered to be 'active', whereas 'retired' codes are 'inactive'.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "If the activeOnly element is missing, the inclusion or exclusion of inactive codes is determined by the value set definition. If this is not specified in the value set definition the behavior is server dependent, but the usual expectation would be that inactive codes will not be included in the expansion",
"isSummary": true
},
{
"id": "ExpansionProfile.excludeNested",
"path": "ExpansionProfile.excludeNested",
"short": "Nested codes in the expansion or not",
"definition": "Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).",
"comment": "Nesting of codes is excluded if excludeNested is present and has a value of \"true\".",
"requirements": "Heirahical contains are useful for UI use, but not when validating. Code Generation etc. may depend on context.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.excludeNotForUI",
"path": "ExpansionProfile.excludeNotForUI",
"short": "Include or exclude codes which cannot be rendered in user interfaces in the value set expansion",
"definition": "Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.",
"comment": "Codes which cannot be used in user interfaces will be excluded if excludeNotForUI is present and has a value of \"true\".",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.excludePostCoordinated",
"path": "ExpansionProfile.excludePostCoordinated",
"short": "Include or exclude codes which are post coordinated expressions in the value set expansion",
"definition": "Controls whether or not the value set expansion includes post coordinated codes.",
"comment": "Post coordinated codes are excluded if excludePostCoordinated is present and has a value of \"true\".",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ExpansionProfile.displayLanguage",
"path": "ExpansionProfile.displayLanguage",
"short": "Specify the language for the display element of codes in the value set expansion",
"definition": "Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "ExpansionProfile.limitedExpansion",
"path": "ExpansionProfile.limitedExpansion",
"short": "Controls behavior of the value set expand operation when value sets are too large to be completely expanded",
"definition": "If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).",
"comment": "This field overrides the default behavior (which is to return an error). This does not apply to expansions which are unbounded. Clients SHALL process the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html) correctly if limitedExpansion = true.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:15+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change