{
"description": "Catalog entries are wrappers that contextualize items included in a catalog.",
"_filename": "catalogentry.profile.json",
"package_name": "hl7.fhir.r5.examples",
"date": "2021-05-03T21:59:52+10:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2021-05-03T21:59:52.634+10:00"
},
"publisher": "Health Level Seven International (Orders and Observations)",
"fhirVersion": "4.6.0",
"name": "CatalogEntry",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "CatalogEntry",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Documents"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "oo"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"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",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "CatalogEntry",
"min": 0,
"definition": "Catalog entries are wrappers that contextualize items included in a catalog.",
"isModifier": false,
"short": "An entry in a catalog",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "MFE",
"identity": "v2"
}, {
"map": "conformance.content",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry",
"base": {
"max": "*",
"min": 0,
"path": "CatalogEntry"
},
"isSummary": false
}, {
"path": "CatalogEntry.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.id",
"comment": "Typically, the resource has an id except for cases like the create operation, conditional updates.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.implicitRules",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/definition",
"valueString": "A human language."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "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
} ],
"description": "IETF language tag"
},
"max": "1",
"id": "CatalogEntry.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "CatalogEntry.text",
"comment": "Contained resources do not have a 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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "CatalogEntry.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "CatalogEntry.contained",
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CatalogEntry.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CatalogEntry.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CatalogEntry.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CatalogEntry.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.identifier",
"min": 0,
"definition": "Business identifier uniquely assigned to the catalog entry.",
"isModifier": false,
"short": "Business identifier of the catalog entry",
"mapping": [ {
"map": "MFE-4",
"identity": "v2"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.identifier",
"base": {
"max": "*",
"min": 0,
"path": "CatalogEntry.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.name",
"min": 0,
"definition": "The name of this catalog entry announces the item that is represented by the entry.",
"isModifier": false,
"short": "Displayable name assigned to the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.name",
"example": [ {
"label": "General",
"valueString": "urinalysis panel for lab Z"
} ],
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.type",
"min": 0,
"definition": "The type of resource that is represented by this catalog entry.",
"isModifier": false,
"short": "ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-type|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryType"
} ],
"description": "Types of resources that can be attached to catalog entries."
},
"max": "1",
"id": "CatalogEntry.type",
"example": [ {
"label": "General",
"valueCode": "ActivityDefinition"
} ],
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.status",
"min": 0,
"definition": "Indicates whether this catalog entry is open to public usage (active) or not (draft or retired).",
"isModifier": true,
"short": "draft | active | retired",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-status|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryStatus"
} ],
"description": "Public usability statuses for catalog entries."
},
"max": "1",
"id": "CatalogEntry.status",
"example": [ {
"label": "General",
"valueCode": "active"
} ],
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.status"
},
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.effectivePeriod",
"min": 0,
"definition": "Period of usability of the catalog entry.",
"isModifier": false,
"short": "When this catalog entry is expected to be active",
"mapping": [ {
"map": "MFE-3",
"identity": "v2"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.effectivePeriod",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.effectivePeriod"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.orderable",
"min": 1,
"definition": "Indicates whether or not the entry represents an item that is orderable.",
"isModifier": true,
"short": "Is orderable",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.orderable",
"example": [ {
"label": "General",
"valueBoolean": true
} ],
"base": {
"max": "1",
"min": 1,
"path": "CatalogEntry.orderable"
},
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.referencedItem",
"min": 1,
"definition": "The item (resource) that this entry of the catalog represents.",
"isModifier": false,
"short": "Item attached to this entry of the catalog",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition", "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge", "http://hl7.org/fhir/StructureDefinition/Substance", "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.referencedItem",
"base": {
"max": "1",
"min": 1,
"path": "CatalogEntry.referencedItem"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.relatedEntry",
"min": 0,
"definition": "Used for example, to point to a substance, or to a device used to administer a medication.",
"isModifier": false,
"short": "Another entry of the catalog related to this one",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.relatedEntry",
"base": {
"max": "*",
"min": 0,
"path": "CatalogEntry.relatedEntry"
},
"isSummary": false
}, {
"path": "CatalogEntry.relatedEntry.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUri": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CatalogEntry.relatedEntry.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CatalogEntry.relatedEntry.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CatalogEntry.relatedEntry.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "CatalogEntry.relatedEntry.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CatalogEntry.relatedEntry.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.relatedEntry.relationship",
"min": 1,
"definition": "The type of relationship to the related entry.",
"isModifier": false,
"short": "triggers | is-replaced-by | excludes | includes",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-relation-type|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryRelationType"
} ],
"description": "Types of relationships between entries."
},
"max": "1",
"id": "CatalogEntry.relatedEntry.relationship",
"base": {
"max": "1",
"min": 1,
"path": "CatalogEntry.relatedEntry.relationship"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.relatedEntry.target",
"min": 1,
"definition": "The reference to the related entry.",
"isModifier": false,
"short": "The reference to the related entry",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CatalogEntry" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.relatedEntry.target",
"base": {
"max": "1",
"min": 1,
"path": "CatalogEntry.relatedEntry.target"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.updatedBy",
"min": 0,
"definition": "Last actor who recorded (created or updated) this catalog entry.",
"isModifier": false,
"short": "Last updater of this catalog entry",
"mapping": [ {
"map": "MFE-7",
"identity": "v2"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Person", "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.updatedBy",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.updatedBy"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.note",
"min": 0,
"definition": "Notes and comments about this catalog entry.",
"isModifier": false,
"short": "Notes and comments about this catalog entry",
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.note",
"base": {
"max": "*",
"min": 0,
"path": "CatalogEntry.note"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.estimatedDuration",
"min": 0,
"definition": "Estimated duration of the orderable item of this entry of the catalog.",
"isModifier": false,
"short": "Estimated duration of the orderable item",
"type": [ {
"code": "Duration"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.estimatedDuration",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.estimatedDuration"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.billingCode",
"min": 0,
"definition": "Billing code associated to the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Billing code in the context of this catalog entry",
"mapping": [ {
"map": "CDM-7",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/cpt-all",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryBilling"
} ],
"description": "Billing codes for entries of catalogs of orderable items."
},
"max": "*",
"id": "CatalogEntry.billingCode",
"base": {
"max": "*",
"min": 0,
"path": "CatalogEntry.billingCode"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.billingSummary",
"min": 0,
"definition": "Billing summary attached to the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Billing summary in the context of this catalog entry",
"mapping": [ {
"map": "CDM-4",
"identity": "v2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.billingSummary",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.billingSummary"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.scheduleSummary",
"min": 0,
"definition": "Schedule summary for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Schedule summary for the catalog entry",
"mapping": [ {
"map": "OM1-40",
"identity": "v2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.scheduleSummary",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.scheduleSummary"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.limitationSummary",
"min": 0,
"definition": "Summary of limitations for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Summary of limitations for the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.limitationSummary",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.limitationSummary"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CatalogEntry.regulatorySummary",
"min": 0,
"definition": "Regulatory summary for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Regulatory summary for the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.regulatorySummary",
"base": {
"max": "1",
"min": 0,
"path": "CatalogEntry.regulatorySummary"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "3bd6fbee-95c0-42fc-9377-dfece12f8843",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/CatalogEntry",
"version": "4.6.0",
"differential": {
"element": [ {
"path": "CatalogEntry",
"min": 0,
"definition": "Catalog entries are wrappers that contextualize items included in a catalog.",
"isModifier": false,
"short": "An entry in a catalog",
"mapping": [ {
"map": "MFE",
"identity": "v2"
}, {
"map": "conformance.content",
"identity": "w5"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry"
}, {
"path": "CatalogEntry.identifier",
"min": 0,
"definition": "Business identifier uniquely assigned to the catalog entry.",
"isModifier": false,
"short": "Business identifier of the catalog entry",
"mapping": [ {
"map": "MFE-4",
"identity": "v2"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.identifier",
"isSummary": true
}, {
"path": "CatalogEntry.name",
"min": 0,
"definition": "The name of this catalog entry announces the item that is represented by the entry.",
"isModifier": false,
"short": "Displayable name assigned to the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.name",
"example": [ {
"label": "General",
"valueString": "urinalysis panel for lab Z"
} ],
"isSummary": true
}, {
"path": "CatalogEntry.type",
"min": 0,
"definition": "The type of resource that is represented by this catalog entry.",
"isModifier": false,
"short": "ActivityDefinition | PlanDefinition | SpecimenDefinition | ObservationDefinition | DeviceDefinition | Organization | Practitioner | PractitionerRole | HealthcareService | MedicationKnowledge | Medication | Substance | Location",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-type|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryType"
} ],
"description": "Types of resources that can be attached to catalog entries."
},
"max": "1",
"id": "CatalogEntry.type",
"example": [ {
"label": "General",
"valueCode": "ActivityDefinition"
} ],
"isSummary": true
}, {
"path": "CatalogEntry.status",
"min": 0,
"definition": "Indicates whether this catalog entry is open to public usage (active) or not (draft or retired).",
"isModifier": true,
"short": "draft | active | retired",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-status|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryStatus"
} ],
"description": "Public usability statuses for catalog entries."
},
"max": "1",
"id": "CatalogEntry.status",
"example": [ {
"label": "General",
"valueCode": "active"
} ],
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": true
}, {
"path": "CatalogEntry.effectivePeriod",
"min": 0,
"definition": "Period of usability of the catalog entry.",
"isModifier": false,
"short": "When this catalog entry is expected to be active",
"mapping": [ {
"map": "MFE-3",
"identity": "v2"
} ],
"type": [ {
"code": "Period"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.effectivePeriod",
"isSummary": false
}, {
"path": "CatalogEntry.orderable",
"min": 1,
"definition": "Indicates whether or not the entry represents an item that is orderable.",
"isModifier": true,
"short": "Is orderable",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.orderable",
"example": [ {
"label": "General",
"valueBoolean": true
} ],
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": true
}, {
"path": "CatalogEntry.referencedItem",
"min": 1,
"definition": "The item (resource) that this entry of the catalog represents.",
"isModifier": false,
"short": "Item attached to this entry of the catalog",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DeviceDefinition", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/HealthcareService", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/SpecimenDefinition", "http://hl7.org/fhir/StructureDefinition/ObservationDefinition", "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge", "http://hl7.org/fhir/StructureDefinition/Substance", "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.referencedItem",
"isSummary": true
}, {
"path": "CatalogEntry.relatedEntry",
"min": 0,
"definition": "Used for example, to point to a substance, or to a device used to administer a medication.",
"isModifier": false,
"short": "Another entry of the catalog related to this one",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.relatedEntry",
"isSummary": false
}, {
"path": "CatalogEntry.relatedEntry.relationship",
"min": 1,
"definition": "The type of relationship to the related entry.",
"isModifier": false,
"short": "triggers | is-replaced-by | excludes | includes",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/catalogentry-relation-type|4.6.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryRelationType"
} ],
"description": "Types of relationships between entries."
},
"max": "1",
"id": "CatalogEntry.relatedEntry.relationship",
"isSummary": false
}, {
"path": "CatalogEntry.relatedEntry.target",
"min": 1,
"definition": "The reference to the related entry.",
"isModifier": false,
"short": "The reference to the related entry",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CatalogEntry" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.relatedEntry.target",
"isSummary": false
}, {
"path": "CatalogEntry.updatedBy",
"min": 0,
"definition": "Last actor who recorded (created or updated) this catalog entry.",
"isModifier": false,
"short": "Last updater of this catalog entry",
"mapping": [ {
"map": "MFE-7",
"identity": "v2"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Person", "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.updatedBy",
"isSummary": false
}, {
"path": "CatalogEntry.note",
"min": 0,
"definition": "Notes and comments about this catalog entry.",
"isModifier": false,
"short": "Notes and comments about this catalog entry",
"type": [ {
"code": "Annotation"
} ],
"mustSupport": false,
"max": "*",
"id": "CatalogEntry.note",
"isSummary": false
}, {
"path": "CatalogEntry.estimatedDuration",
"min": 0,
"definition": "Estimated duration of the orderable item of this entry of the catalog.",
"isModifier": false,
"short": "Estimated duration of the orderable item",
"type": [ {
"code": "Duration"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.estimatedDuration",
"isSummary": false
}, {
"path": "CatalogEntry.billingCode",
"min": 0,
"definition": "Billing code associated to the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Billing code in the context of this catalog entry",
"mapping": [ {
"map": "CDM-7",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/cpt-all",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CatalogEntryBilling"
} ],
"description": "Billing codes for entries of catalogs of orderable items."
},
"max": "*",
"id": "CatalogEntry.billingCode",
"isSummary": true
}, {
"path": "CatalogEntry.billingSummary",
"min": 0,
"definition": "Billing summary attached to the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Billing summary in the context of this catalog entry",
"mapping": [ {
"map": "CDM-4",
"identity": "v2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.billingSummary",
"isSummary": true
}, {
"path": "CatalogEntry.scheduleSummary",
"min": 0,
"definition": "Schedule summary for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Schedule summary for the catalog entry",
"mapping": [ {
"map": "OM1-40",
"identity": "v2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.scheduleSummary",
"isSummary": false
}, {
"path": "CatalogEntry.limitationSummary",
"min": 0,
"definition": "Summary of limitations for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Summary of limitations for the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.limitationSummary",
"isSummary": false
}, {
"path": "CatalogEntry.regulatorySummary",
"min": 0,
"definition": "Regulatory summary for the item in the context of this entry of the catalog.",
"isModifier": false,
"short": "Regulatory summary for the catalog entry",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "CatalogEntry.regulatorySummary",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/orders/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}