This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Source for DictionaryHSPC Quantitative Labs dictionary
{
"resourceType": "Bundle",
"id": "resources",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"type": "collection",
"base": "http://hl7.org/fhir",
"entry": [
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ValueSet-expand",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"name": "Value Set Expansion",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation. \n\nIf the operation is not called at the instance level, one of the in parameters identifier or valueset must be provided.\n\nAn expanded value set will be returned, or an OperationOutcome with an error message",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "expand",
"notes": "The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used. \n\nDifferent servers may return different results from expanding a value set for the following reasons:\n\n* The underlying code systems are different (e.g. different versions, possibly with different defined behaviour)\n* The server optimises filter includes differently, such as sorting by code frequency\n* Servers introduce arbitrary groups to assist a user to navigate the lists based either on extensions in the definition, or additional knowledge available to the server",
"system": false,
"type": [
"ValueSet"
],
"instance": true,
"parameter": [
{
"name": "identifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A logical value set identifier (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly in the server's valuesets, or it is defined implicitly by some code system known to the server",
"type": "uri"
},
{
"name": "valueSet",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion",
"type": "ValueSet"
},
{
"name": "filter",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A text filter that is applied to restrict the codes that are returned (this is useful in a UI context)",
"type": "string"
},
{
"name": "profile",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A reference to an external definition that provides additional control information about how the expansion is performed.\n\nAt this time, there is no agreed format or funtionality for the target of this URI. The [VSAC Documentation](http://www.nlm.nih.gov/vsac/support/authorguidelines/updatingvaluesets.html) provides one example of the use of this parameter. Implementers using this element will need to agree on an appropriate mechanism for use within their interoperability community",
"type": "uri"
},
{
"name": "date",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date for which the expansion should be generated. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type": "dateTime"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The result of the expansion",
"type": "ValueSet"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ValueSet-lookup",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ValueSet-lookup",
"name": "Concept Look Up",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Given a code/system, or a Coding, get additional details about the concept",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "lookup",
"system": false,
"type": [
"ValueSet"
],
"instance": false,
"parameter": [
{
"name": "code",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The code that is to be validated. If a code is provided, a system must be provided",
"type": "code"
},
{
"name": "system",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The system for the code that is to be validated",
"type": "uri"
},
{
"name": "version",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The version of the system, if one was provided in the source data",
"type": "string"
},
{
"name": "coding",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A coding to look up",
"type": "Coding"
},
{
"name": "date",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type": "dateTime"
},
{
"name": "name",
"use": "out",
"min": 1,
"max": "1",
"documentation": "A display name for the code system",
"type": "string"
},
{
"name": "version",
"use": "out",
"min": 0,
"max": "1",
"documentation": "The version that these details are based on",
"type": "string"
},
{
"name": "display",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The preferred display for this concept",
"type": "string"
},
{
"name": "abstract",
"use": "out",
"min": 0,
"max": "1",
"documentation": "Whether this code is an abstract concept",
"type": "boolean"
},
{
"name": "designation",
"use": "out",
"min": 0,
"max": "*",
"documentation": "Additional representations for this concept",
"part": [
{
"name": "language",
"min": 0,
"max": "1",
"documentation": "The language this designation is defined for",
"type": "code"
},
{
"name": "use",
"min": 0,
"max": "1",
"documentation": "A code that details how this designation would be used",
"type": "Coding"
},
{
"name": "value",
"min": 1,
"max": "1",
"documentation": "The text value for this designation",
"type": "string"
}
]
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ValueSet-validate-code",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code",
"name": "Value Set based Validation",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Validate that a coded value is in the set of codes allowed by a value set. \n\nIf the operation is not called at the instance level, one of the in parameters \"identifier\" or \"valueset\" must be provided.\n\nOne (and only one) of the in parameters (code, coding, codeableConcept) must be provided.\n\nThe operation returns a result (true / false), an error message, and the recommended display for the code",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "validate-code",
"system": false,
"type": [
"ValueSet"
],
"instance": true,
"parameter": [
{
"name": "identifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A logical value set identifier (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly in the server's valuesets, or it is defined implicitly by some code system known to the server",
"type": "uri"
},
{
"name": "valueSet",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion",
"type": "ValueSet"
},
{
"name": "code",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The code that is to be validated. If a code is provided, a system must be provided",
"type": "code"
},
{
"name": "system",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The system for the code that is to be validated",
"type": "uri"
},
{
"name": "version",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The version of the system, if one was provided in the source data",
"type": "string"
},
{
"name": "display",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return athe recommended display name in an extension in the outcome",
"type": "string"
},
{
"name": "coding",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A coding to validate",
"type": "Coding"
},
{
"name": "codeableConcept",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other",
"type": "CodeableConcept"
},
{
"name": "date",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type": "dateTime"
},
{
"name": "abstract",
"use": "in",
"min": 0,
"max": "1",
"documentation": "if true, then an abstract code is allowed to be used in the context of the code that is being validated. Typically, abstract codes are allowed to be used in value set specifications (e.g. any code that is subsumed by an abstract code). If false (which is the default value), then only concrete codes as defined by the value set are allowed",
"type": "boolean"
},
{
"name": "result",
"use": "out",
"min": 1,
"max": "1",
"documentation": "True if the concept details supplied are valid",
"type": "boolean"
},
{
"name": "message",
"use": "out",
"min": 0,
"max": "1",
"documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings",
"type": "string"
},
{
"name": "display",
"use": "out",
"min": 0,
"max": "1",
"documentation": "A valid display for the concept if the system wishes to display this to a user",
"type": "string"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ValueSet-batch",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ValueSet-batch",
"name": "Batch Mode Validation",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Validate a set of concepts against value sets in a single oeration\n\nTypically, this would be called when a validating a resource or document that contains many codes, to reduce network latency events",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "batch",
"system": false,
"type": [
"ValueSet"
],
"instance": false,
"parameter": [
{
"name": "item",
"use": "in",
"min": 0,
"max": "*",
"documentation": "An item to be validated",
"part": [
{
"name": "concept",
"min": 1,
"max": "1",
"documentation": "A codeable concept to be validated. If the source is a coding, or a code/system pair, wrap it in a CodeableConcept",
"type": "CodeableConcept"
},
{
"name": "uri",
"min": 1,
"max": "1",
"documentation": "The value set to validate the concept against. This is a logical value set identifier (i.e. ValueSet.identifier). The server must know the value set (e.g. it is defined explicitly in the server's valuesets, or it is defined implicitly by some code system known to the server",
"type": "uri"
}
]
},
{
"name": "date",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.",
"type": "dateTime"
},
{
"name": "item",
"use": "out",
"min": 0,
"max": "*",
"documentation": "The outcome of validating an item. There must be an entry for every item in the same order",
"part": [
{
"name": "result",
"min": 1,
"max": "1",
"documentation": "True if the concept details supplied are valid",
"type": "boolean"
},
{
"name": "message",
"min": 0,
"max": "1",
"documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings",
"type": "string"
},
{
"name": "display",
"min": 0,
"max": "1",
"documentation": "A valid display for the concept if the system wishes to display this to a user",
"type": "string"
}
]
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ValueSet",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ValueSet",
"name": "ValueSet",
"publisher": "HL7 FHIR Project (Vocabulary)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ValueSet Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "define.xml2.0",
"uri": "http://www.cdisc.org/define-xml",
"name": "CDISC Define XML 2.0 metadata standard"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ValueSet",
"short": "A set of codes drawn from one or more code systems",
"definition": "A value set specifies a set of codes drawn from one or more code systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "ValueSet"
}
],
"constraint": [
{
"key": "vsd-7",
"severity": "error",
"human": "A defined code system (if present) SHALL have a different identifier to the value set itself",
"xpath": "not(f:define/f:system/@value = f:identifier/@value)"
},
{
"key": "vsd-5",
"severity": "error",
"human": "Value set SHALL contain either a define, a compose, or an expansion element",
"xpath": "exists(f:define) or exists(f:compose) or exists(f:expansion)"
},
{
"key": "vsd-2",
"severity": "error",
"human": "A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes",
"xpath": "not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ValueSet.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ValueSet.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ValueSet.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ValueSet.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ValueSet.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.url",
"short": "Globally unique logical id for value set",
"definition": "An absolute uri that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.identifier",
"short": "Additional identifier for the value set (v2 / CDA)",
"definition": "Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "define.xml2.0",
"map": "Identifier part"
}
]
},
{
"path": "ValueSet.version",
"short": "Logical id for this version of the value set",
"definition": "Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the value set that have the same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.name",
"short": "Informal name for this value set",
"definition": "A free text natural language name describing the value set.",
"comments": "The name is not expected to be unique. A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.useContext",
"short": "Content intends to support these contexts",
"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 of value set definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "define.xml2.0",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
}
]
},
{
"path": "ValueSet.immutable",
"short": "Indicates whether or not any change to the content logical definition may occur",
"definition": "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.",
"comments": "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one Value Set Version for this Definition. Immutability tends to be set to 'true' in one of two cases:\n- Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\"\n- Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition\nSource workflow control must guarantee that the same URI always yields the same definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the value set.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "ValueSet.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the value set.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "ValueSet.description",
"short": "Human language description of the value set",
"definition": "A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.",
"comments": "The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. . A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.",
"requirements": "Human understandability.",
"alias": [
"Scope",
"Purpose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.requirements",
"short": "Why is this needed?",
"definition": "Explains why this value set is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the value set (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.",
"comments": "Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.status",
"short": "draft | active | retired",
"definition": "The status of the value set.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"requirements": "Identify when/if the value set should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.extensible",
"short": "Whether this is intended to be used with an extensible binding",
"definition": "Whether this is intended to be used with an extensible binding or not.",
"requirements": "It is not required to say whether this intent applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.date",
"short": "Date for given status",
"definition": "The date that the value set status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set.",
"requirements": "Need to know when a value set was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.lockedDate",
"short": "Fixed date for all referenced code systems and value sets",
"definition": "If a Locked Date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value sets as of the Locked Date.",
"comments": "With a defined Locked Date the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true
},
{
"path": "ValueSet.define",
"short": "When value set defines its own codes",
"definition": "A definition of an code system, inlined into the value set.",
"comments": "All code systems defined as part of a FHIR value set have an implicit valueset that includes all the code in the code system - the value set in which they are defined.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "vsd-8",
"severity": "error",
"human": "Codes must be unique",
"xpath": "count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))"
},
{
"key": "vsd-3",
"severity": "error",
"human": "Within a code system definition, all the codes SHALL be unique",
"xpath": "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.define.system",
"short": "URI to identify the code system",
"definition": "An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.version",
"short": "Version of this system",
"definition": "The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.caseSensitive",
"short": "If code comparison is case sensitive",
"definition": "If code comparison is case sensitive when codes within this system are compared to each other.",
"comments": "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.concept",
"name": "concept",
"short": "Concepts in the code system",
"definition": "Concepts in the code system.",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.define.concept.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.concept.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.concept.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.define.concept.code",
"short": "Code that identifies concept",
"definition": "Code that identifies concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ValueSet.define.concept.abstract",
"short": "If this code is not for use as a real concept",
"definition": "If this code is not for use as a real concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
},
{
"path": "ValueSet.define.concept.display",
"short": "Text to Display to the user",
"definition": "Text to Display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.definition",
"short": "Formal Definition",
"definition": "The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.designation",
"name": "designation",
"short": "Additional representations for the concept",
"definition": "Additional representations for the concept - other languages, aliases, specialised purposes, used for particular purposes, etc.",
"requirements": "many concept definition systems support mltiple representations, in multiple languages, and for mltiple purposes.",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.define.concept.designation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.concept.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.define.concept.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.define.concept.designation.language",
"short": "Language of the designation",
"definition": "The language this designation is defined for.",
"comments": "In the absense of a language, the resource language applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ValueSet.define.concept.designation.use",
"short": "Details how this designation would be used",
"definition": "A code that details how this designation would be used.",
"comments": "if no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ConceptDesignationUse",
"strength": "extensible",
"description": "Details of how a designation would be used",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/designation-use"
}
}
},
{
"path": "ValueSet.define.concept.designation.value",
"short": "The text value for this designation",
"definition": "The text value for this designation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.concept",
"short": "Child Concepts (is-a / contains)",
"definition": "Child Concepts (is-a / contains).",
"min": 0,
"max": "*",
"nameReference": "concept"
},
{
"path": "ValueSet.compose",
"short": "When value set includes codes from elsewhere",
"definition": "When value set includes codes from elsewhere.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "vsd-1",
"severity": "error",
"human": "A value set composition SHALL have an include or an import",
"xpath": "exists(f:include) or exists(f:import)"
}
]
},
{
"path": "ValueSet.compose.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.import",
"short": "Import the contents of another value set",
"definition": "Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri.",
"comments": "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference a actual FHIR value set resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"condition": [
"vsd-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include",
"name": "include",
"short": "Include one or more codes from a code system",
"definition": "Include one or more codes from a code system.",
"comments": "If there are no codes or filters, the entire code system is included. Note that the set of codes hat are included may contain abstract codes.",
"min": 0,
"max": "*",
"condition": [
"vsd-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.system",
"short": "The system the codes come from",
"definition": "An absolute URI which is the code system from which the selected codes come from.",
"comments": "See *Coding.system* for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Href"
}
]
},
{
"path": "ValueSet.compose.include.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system that the codes are selected from.",
"comments": "This is used when selecting the descendents of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Version"
}
]
},
{
"path": "ValueSet.compose.include.concept",
"short": "A concept defined in the system",
"definition": "Specifies a concept to be included or excluded.",
"comments": "The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order an an expansion follows that defined in the compose.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.include.concept.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.include.concept.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.code",
"short": "Code or expression from system",
"definition": "Specifies a code for the concept to be included or excluded.",
"comments": "Expressions are allowed if defined by the underlying code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.display",
"short": "Test to display for this code for this value set",
"definition": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.",
"comments": "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.designation",
"short": "Additional representations for this valueset",
"definition": "Additional representations for this concept when used in this value set - other languages, aliases, specialised purposes, used for particular purposes, etc.",
"min": 0,
"max": "*",
"nameReference": "designation"
},
{
"path": "ValueSet.compose.include.filter",
"short": "Select codes/concepts by their properties (including relationships)",
"definition": "Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.",
"comments": "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.include.filter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.compose.include.filter.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.property",
"short": "A property defined by the code system",
"definition": "A code that identifies a property defined in the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.op",
"short": "= | is-a | is-not-a | regex | in | not-in",
"definition": "The kind of operation to perform as a part of the filter criteria.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "FilterOperator",
"strength": "required",
"description": "The kind of operation to perform as a part of a property based filter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/filter-operator"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.value",
"short": "Code from the system, or regex criteria",
"definition": "The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.",
"comments": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.exclude",
"short": "Explicitly exclude codes",
"definition": "Exclude one or more codes from the value set.",
"comments": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.",
"min": 0,
"max": "*",
"nameReference": "include",
"condition": [
"vsd-2"
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.expansion",
"short": "Used when the value set is \"expanded\"",
"definition": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.",
"comments": "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
]
},
{
"path": "ValueSet.expansion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.expansion.identifier",
"short": "Uniquely identifies this expansion",
"definition": "An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.",
"comments": "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ValueSet.expansion.timestamp",
"short": "Time valueset expansion happened",
"definition": "The time at which the expansion was produced by the expanding system.",
"comments": "This SHOULD have be a fully populated instant, but in some circumstances, value sets are expanded by hand, of the expansion is published without that precision.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ValueSet.expansion.parameter",
"short": "Parameter that controlled the expansion process",
"definition": "A Parameter that controlled the expansion process. These paameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.",
"comments": "The server decides which parameters to include here, but as a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.expansion.parameter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.parameter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.parameter.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.expansion.parameter.name",
"short": "Name as assigned by server",
"definition": "The name of the parameter.",
"comments": "The names are assigned at the discretion of the server.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.expansion.parameter.value[x]",
"short": "Value of the parameter",
"definition": "The value of the parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "uri"
},
{
"code": "code"
}
],
"condition": [
"vsd-1"
]
},
{
"path": "ValueSet.expansion.contains",
"name": "contains",
"short": "Codes in the value set",
"definition": "The codes that are contained in the value set expansion.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "vsd-9",
"severity": "error",
"human": "Must have a code if not abstract",
"xpath": "exists(f:code) or (f:display/@value = 'true')"
},
{
"key": "vsd-6",
"severity": "error",
"human": "SHALL have a code or a display",
"xpath": "exists(f:code) or exists(f:display)"
},
{
"key": "vsd-10",
"severity": "error",
"human": "Must have a system if a code is present",
"xpath": "exists(f:system) or not(exists(f:code))"
}
]
},
{
"path": "ValueSet.expansion.contains.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.contains.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ValueSet.expansion.contains.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.expansion.contains.system",
"short": "System value for the code",
"definition": "An absolute URI which is the code system in which the code for this item in the expansion is defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ValueSet.expansion.contains.abstract",
"short": "If user cannot select this entry",
"definition": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.",
"comments": "This shouldn't be understood to exclude its use for searchig (e..g by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ValueSet.expansion.contains.version",
"short": "Version in which this code / display is defined",
"definition": "The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.",
"comments": "The exact value of the version string is specified by the system from which the code is derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.expansion.contains.code",
"short": "Code - if blank, this is not a choosable code",
"definition": "Code - if blank, this is not a choosable code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"vsd-6"
]
},
{
"path": "ValueSet.expansion.contains.display",
"short": "User display for the concept",
"definition": "User display for the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"vsd-6"
]
},
{
"path": "ValueSet.expansion.contains.contains",
"short": "Codes contained in this concept",
"definition": "Codes contained in this concept.",
"min": 0,
"max": "*",
"nameReference": "contains"
}
]
},
"differential": {
"element": [
{
"path": "ValueSet",
"short": "A set of codes drawn from one or more code systems",
"definition": "A value set specifies a set of codes drawn from one or more code systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "vsd-7",
"severity": "error",
"human": "A defined code system (if present) SHALL have a different identifier to the value set itself",
"xpath": "not(f:define/f:system/@value = f:identifier/@value)"
},
{
"key": "vsd-5",
"severity": "error",
"human": "Value set SHALL contain either a define, a compose, or an expansion element",
"xpath": "exists(f:define) or exists(f:compose) or exists(f:expansion)"
},
{
"key": "vsd-2",
"severity": "error",
"human": "A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes",
"xpath": "not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.url",
"short": "Globally unique logical id for value set",
"definition": "An absolute uri that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.identifier",
"short": "Additional identifier for the value set (v2 / CDA)",
"definition": "Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "define.xml2.0",
"map": "Identifier part"
}
]
},
{
"path": "ValueSet.version",
"short": "Logical id for this version of the value set",
"definition": "Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the value set that have the same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.name",
"short": "Informal name for this value set",
"definition": "A free text natural language name describing the value set.",
"comments": "The name is not expected to be unique. A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.useContext",
"short": "Content intends to support these contexts",
"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 of value set definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "define.xml2.0",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
}
]
},
{
"path": "ValueSet.immutable",
"short": "Indicates whether or not any change to the content logical definition may occur",
"definition": "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.",
"comments": "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one Value Set Version for this Definition. Immutability tends to be set to 'true' in one of two cases:\n- Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\"\n- Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition\nSource workflow control must guarantee that the same URI always yields the same definition.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the value set.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "ValueSet.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the value set.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "ValueSet.description",
"short": "Human language description of the value set",
"definition": "A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.",
"comments": "The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. . A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.",
"requirements": "Human understandability.",
"alias": [
"Scope",
"Purpose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.requirements",
"short": "Why is this needed?",
"definition": "Explains why this value set is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the value set (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.",
"comments": "Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.status",
"short": "draft | active | retired",
"definition": "The status of the value set.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"requirements": "Identify when/if the value set should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.extensible",
"short": "Whether this is intended to be used with an extensible binding",
"definition": "Whether this is intended to be used with an extensible binding or not.",
"requirements": "It is not required to say whether this intent applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.date",
"short": "Date for given status",
"definition": "The date that the value set status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set.",
"requirements": "Need to know when a value set was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.lockedDate",
"short": "Fixed date for all referenced code systems and value sets",
"definition": "If a Locked Date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value sets as of the Locked Date.",
"comments": "With a defined Locked Date the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true
},
{
"path": "ValueSet.define",
"short": "When value set defines its own codes",
"definition": "A definition of an code system, inlined into the value set.",
"comments": "All code systems defined as part of a FHIR value set have an implicit valueset that includes all the code in the code system - the value set in which they are defined.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "vsd-8",
"severity": "error",
"human": "Codes must be unique",
"xpath": "count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))"
},
{
"key": "vsd-3",
"severity": "error",
"human": "Within a code system definition, all the codes SHALL be unique",
"xpath": "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.system",
"short": "URI to identify the code system",
"definition": "An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.version",
"short": "Version of this system",
"definition": "The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.caseSensitive",
"short": "If code comparison is case sensitive",
"definition": "If code comparison is case sensitive when codes within this system are compared to each other.",
"comments": "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ValueSet.define.concept",
"name": "concept",
"short": "Concepts in the code system",
"definition": "Concepts in the code system.",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.define.concept.code",
"short": "Code that identifies concept",
"definition": "Code that identifies concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ValueSet.define.concept.abstract",
"short": "If this code is not for use as a real concept",
"definition": "If this code is not for use as a real concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
},
{
"path": "ValueSet.define.concept.display",
"short": "Text to Display to the user",
"definition": "Text to Display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.definition",
"short": "Formal Definition",
"definition": "The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.designation",
"name": "designation",
"short": "Additional representations for the concept",
"definition": "Additional representations for the concept - other languages, aliases, specialised purposes, used for particular purposes, etc.",
"requirements": "many concept definition systems support mltiple representations, in multiple languages, and for mltiple purposes.",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.define.concept.designation.language",
"short": "Language of the designation",
"definition": "The language this designation is defined for.",
"comments": "In the absense of a language, the resource language applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ValueSet.define.concept.designation.use",
"short": "Details how this designation would be used",
"definition": "A code that details how this designation would be used.",
"comments": "if no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ConceptDesignationUse",
"strength": "extensible",
"description": "Details of how a designation would be used",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/designation-use"
}
}
},
{
"path": "ValueSet.define.concept.designation.value",
"short": "The text value for this designation",
"definition": "The text value for this designation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.define.concept.concept",
"short": "Child Concepts (is-a / contains)",
"definition": "Child Concepts (is-a / contains).",
"min": 0,
"max": "*",
"nameReference": "concept"
},
{
"path": "ValueSet.compose",
"short": "When value set includes codes from elsewhere",
"definition": "When value set includes codes from elsewhere.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "vsd-1",
"severity": "error",
"human": "A value set composition SHALL have an include or an import",
"xpath": "exists(f:include) or exists(f:import)"
}
]
},
{
"path": "ValueSet.compose.import",
"short": "Import the contents of another value set",
"definition": "Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri.",
"comments": "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may also not reference a actual FHIR value set resource; in this case, whatever is referenced is an implicit definition of a value set that needs to be clear about how versions are resolved.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"condition": [
"vsd-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include",
"name": "include",
"short": "Include one or more codes from a code system",
"definition": "Include one or more codes from a code system.",
"comments": "If there are no codes or filters, the entire code system is included. Note that the set of codes hat are included may contain abstract codes.",
"min": 0,
"max": "*",
"condition": [
"vsd-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.system",
"short": "The system the codes come from",
"definition": "An absolute URI which is the code system from which the selected codes come from.",
"comments": "See *Coding.system* for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Href"
}
]
},
{
"path": "ValueSet.compose.include.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system that the codes are selected from.",
"comments": "This is used when selecting the descendents of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Version"
}
]
},
{
"path": "ValueSet.compose.include.concept",
"short": "A concept defined in the system",
"definition": "Specifies a concept to be included or excluded.",
"comments": "The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order an an expansion follows that defined in the compose.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.code",
"short": "Code or expression from system",
"definition": "Specifies a code for the concept to be included or excluded.",
"comments": "Expressions are allowed if defined by the underlying code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.display",
"short": "Test to display for this code for this value set",
"definition": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.",
"comments": "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.concept.designation",
"short": "Additional representations for this valueset",
"definition": "Additional representations for this concept when used in this value set - other languages, aliases, specialised purposes, used for particular purposes, etc.",
"min": 0,
"max": "*",
"nameReference": "designation"
},
{
"path": "ValueSet.compose.include.filter",
"short": "Select codes/concepts by their properties (including relationships)",
"definition": "Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.",
"comments": "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.property",
"short": "A property defined by the code system",
"definition": "A code that identifies a property defined in the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.op",
"short": "= | is-a | is-not-a | regex | in | not-in",
"definition": "The kind of operation to perform as a part of the filter criteria.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "FilterOperator",
"strength": "required",
"description": "The kind of operation to perform as a part of a property based filter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/filter-operator"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.include.filter.value",
"short": "Code from the system, or regex criteria",
"definition": "The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.",
"comments": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.compose.exclude",
"short": "Explicitly exclude codes",
"definition": "Exclude one or more codes from the value set.",
"comments": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.",
"min": 0,
"max": "*",
"nameReference": "include",
"condition": [
"vsd-2"
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ValueSet.expansion",
"short": "Used when the value set is \"expanded\"",
"definition": "A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.",
"comments": "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.",
"min": 0,
"max": "1",
"condition": [
"vsd-5"
]
},
{
"path": "ValueSet.expansion.identifier",
"short": "Uniquely identifies this expansion",
"definition": "An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.",
"comments": "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ValueSet.expansion.timestamp",
"short": "Time valueset expansion happened",
"definition": "The time at which the expansion was produced by the expanding system.",
"comments": "This SHOULD have be a fully populated instant, but in some circumstances, value sets are expanded by hand, of the expansion is published without that precision.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ValueSet.expansion.parameter",
"short": "Parameter that controlled the expansion process",
"definition": "A Parameter that controlled the expansion process. These paameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.",
"comments": "The server decides which parameters to include here, but as a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).",
"min": 0,
"max": "*"
},
{
"path": "ValueSet.expansion.parameter.name",
"short": "Name as assigned by server",
"definition": "The name of the parameter.",
"comments": "The names are assigned at the discretion of the server.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.expansion.parameter.value[x]",
"short": "Value of the parameter",
"definition": "The value of the parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "uri"
},
{
"code": "code"
}
],
"condition": [
"vsd-1"
]
},
{
"path": "ValueSet.expansion.contains",
"name": "contains",
"short": "Codes in the value set",
"definition": "The codes that are contained in the value set expansion.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "vsd-9",
"severity": "error",
"human": "Must have a code if not abstract",
"xpath": "exists(f:code) or (f:display/@value = 'true')"
},
{
"key": "vsd-6",
"severity": "error",
"human": "SHALL have a code or a display",
"xpath": "exists(f:code) or exists(f:display)"
},
{
"key": "vsd-10",
"severity": "error",
"human": "Must have a system if a code is present",
"xpath": "exists(f:system) or not(exists(f:code))"
}
]
},
{
"path": "ValueSet.expansion.contains.system",
"short": "System value for the code",
"definition": "An absolute URI which is the code system in which the code for this item in the expansion is defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ValueSet.expansion.contains.abstract",
"short": "If user cannot select this entry",
"definition": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.",
"comments": "This shouldn't be understood to exclude its use for searchig (e..g by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ValueSet.expansion.contains.version",
"short": "Version in which this code / display is defined",
"definition": "The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.",
"comments": "The exact value of the version string is specified by the system from which the code is derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ValueSet.expansion.contains.code",
"short": "Code - if blank, this is not a choosable code",
"definition": "Code - if blank, this is not a choosable code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"vsd-6"
]
},
{
"path": "ValueSet.expansion.contains.display",
"short": "User display for the concept",
"definition": "User display for the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"vsd-6"
]
},
{
"path": "ValueSet.expansion.contains.contains",
"short": "Codes contained in this concept",
"definition": "Codes contained in this concept.",
"min": 0,
"max": "*",
"nameReference": "contains"
}
]
}
}
},
{
"resource": {
"resourceType": "Conformance",
"id": "base",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/Conformance/base",
"version": "0.4.0-4902",
"name": "Base FHIR Conformance Statement (Full)",
"publisher": "FHIR Project Team",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"fhirVersion": "0.4.0",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "All the functionality defined in FHIR",
"resource": [
{
"type": "Alert",
"profile": {
"reference": "http://hl7.org/fhir/Alert"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/alert-author",
"type": "reference",
"documentation": "Alert creator"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/alert-patient",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/alert-subject",
"type": "reference",
"documentation": "The identity of a subject to list alerts for"
}
]
},
{
"type": "AllergyIntolerance",
"profile": {
"reference": "http://hl7.org/fhir/AllergyIntolerance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-status",
"type": "token",
"documentation": "unconfirmed | confirmed | resolved | refuted | entered-in-error"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-onset",
"type": "date",
"documentation": "Date(/time) when manifestations showed"
},
{
"name": "last-date",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-last-date",
"type": "date",
"documentation": "Date(/time) of last known occurence of a reaction"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-severity",
"type": "token",
"documentation": "mild | moderate | severe (of event as a whole)"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-type",
"type": "token",
"documentation": "immune | non-immune - Underlying mechanism (if known)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-date",
"type": "date",
"documentation": "When recorded"
},
{
"name": "reporter",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-reporter",
"type": "reference",
"documentation": "Source of the information about the allergy"
},
{
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-substance",
"type": "token",
"documentation": "Substance, (or class) considered to be responsible for risk"
},
{
"name": "criticality",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-criticality",
"type": "token",
"documentation": "low | high | unassessible - Estimated potential clinical harm"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-category",
"type": "token",
"documentation": "food | medication | environment - Category of Substance"
},
{
"name": "duration",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-duration",
"type": "quantity",
"documentation": "How long Manifestations persisted"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-patient",
"type": "reference",
"documentation": "Who the sensitivity is for"
},
{
"name": "recorder",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-recorder",
"type": "reference",
"documentation": "Who recorded the sensitivity"
},
{
"name": "route",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-route",
"type": "token",
"documentation": "How the subject was exposed to the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-identifier",
"type": "token",
"documentation": "External Ids for this item"
},
{
"name": "manifestation",
"definition": "http://hl7.org/fhir/SearchParameter/allergyintolerance-manifestation",
"type": "token",
"documentation": "Clinical symptoms/signs associated with the Event"
}
]
},
{
"type": "Appointment",
"profile": {
"reference": "http://hl7.org/fhir/Appointment"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "partstatus",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-partstatus",
"type": "token",
"documentation": "The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests."
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-patient",
"type": "reference",
"documentation": "One of the individuals of the appointment is this patient"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-practitioner",
"type": "reference",
"documentation": "One of the individuals of the appointment is this practitioner"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-location",
"type": "reference",
"documentation": "This location is listed in the participants of the appointment"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-status",
"type": "token",
"documentation": "The overall status of the appointment"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-actor",
"type": "reference",
"documentation": "Any one of the individuals participating in the appointment"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/appointment-date",
"type": "date",
"documentation": "Appointment date/time."
}
]
},
{
"type": "AppointmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/AppointmentResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "partstatus",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-partstatus",
"type": "token",
"documentation": "The participants acceptance status for this appointment"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-patient",
"type": "reference",
"documentation": "This Response is for this Patient"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-practitioner",
"type": "reference",
"documentation": "This Response is for this Practitioner"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-location",
"type": "reference",
"documentation": "This Response is for this Location"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-actor",
"type": "reference",
"documentation": "The Person, Location/HealthcareService or Device that this appointment response replies for"
},
{
"name": "appointment",
"definition": "http://hl7.org/fhir/SearchParameter/appointmentresponse-appointment",
"type": "reference",
"documentation": "The appointment that the response is attached to"
}
]
},
{
"type": "AuditEvent",
"profile": {
"reference": "http://hl7.org/fhir/AuditEvent"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "site",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-site",
"type": "token",
"documentation": "Logical source location within the enterprise"
},
{
"name": "desc",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-desc",
"type": "string",
"documentation": "Instance-specific descriptor for Object"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-type",
"type": "token",
"documentation": "Type/identifier of event"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-date",
"type": "date",
"documentation": "Time when the event occurred on source"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-reference",
"type": "reference",
"documentation": "Specific instance of resource (e.g. versioned)"
},
{
"name": "identity",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-identity",
"type": "token",
"documentation": "Specific instance of object (e.g. versioned)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-patient",
"type": "reference",
"documentation": "A patient that the .object.reference refers to"
},
{
"name": "altid",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-altid",
"type": "token",
"documentation": "Alternative User id e.g. authentication"
},
{
"name": "patientid",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-patientid",
"type": "token",
"documentation": "The id of the patient (one of multiple kinds of participations)"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-source",
"type": "token",
"documentation": "The id of source where event originated"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-address",
"type": "token",
"documentation": "Identifier for the network access point of the user device"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-subtype",
"type": "token",
"documentation": "More specific type/id for the event"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-name",
"type": "string",
"documentation": "Human-meaningful name for the user"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-action",
"type": "token",
"documentation": "Type of action performed during the event"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-participant",
"type": "reference",
"documentation": "Direct reference to resource"
},
{
"name": "policy",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-policy",
"type": "uri",
"documentation": "Policy that authorized event"
},
{
"name": "object-type",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-object-type",
"type": "token",
"documentation": "Object type being audited"
},
{
"name": "user",
"definition": "http://hl7.org/fhir/SearchParameter/auditevent-user",
"type": "token",
"documentation": "Unique identifier for the user"
}
]
},
{
"type": "Basic",
"profile": {
"reference": "http://hl7.org/fhir/Basic"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/basic-author",
"type": "reference",
"documentation": "Who created"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/basic-patient",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/basic-created",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/basic-subject",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/basic-code",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Binary",
"profile": {
"reference": "http://hl7.org/fhir/Binary"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "contenttype",
"definition": "http://hl7.org/fhir/SearchParameter/binary-contenttype",
"type": "token",
"documentation": "MimeType of the binary content"
}
]
},
{
"type": "BodySite",
"profile": {
"reference": "http://hl7.org/fhir/BodySite"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/bodysite-patient",
"type": "reference",
"documentation": "Patient to whom bodysite belongs"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/bodysite-code",
"type": "token",
"documentation": "Named anatomical location"
}
]
},
{
"type": "Bundle",
"profile": {
"reference": "http://hl7.org/fhir/Bundle"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "message",
"definition": "http://hl7.org/fhir/SearchParameter/bundle-message",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"message\" - this is a message header, and this parameter provides access to search its contents"
},
{
"name": "composition",
"definition": "http://hl7.org/fhir/SearchParameter/bundle-composition",
"type": "reference",
"documentation": "The first resource in the bundle, if the bundle type is \"document\" - this is a composition, and this parameter provides access to searches its contents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/bundle-type",
"type": "token",
"documentation": "document | message | transaction | transaction-response | history | searchset | collection"
}
]
},
{
"type": "CarePlan",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "activitycode",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitycode",
"type": "token",
"documentation": "Detail type of activity"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-patient",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "activitydetail",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitydetail",
"type": "reference",
"documentation": "Activity details defined in specific resource"
},
{
"name": "activitydate",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-activitydate",
"type": "date",
"documentation": "Specified date occurs within period specified by CarePlan.activity.timingSchedule"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-performer",
"type": "reference",
"documentation": "Matches if the practitioner is listed as a performer in any of the \"simple\" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-participant",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/careplan-date",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "CarePlan2",
"profile": {
"reference": "http://hl7.org/fhir/CarePlan2"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-patient",
"type": "reference",
"documentation": "Who care plan is for"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-condition",
"type": "reference",
"documentation": "Health issues this plan addresses"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-participant",
"type": "reference",
"documentation": "Who is involved"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/careplan2-date",
"type": "date",
"documentation": "Time period plan covers"
}
]
},
{
"type": "Claim",
"profile": {
"reference": "http://hl7.org/fhir/Claim"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/claim-patient",
"type": "reference",
"documentation": "Patient"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/claim-priority",
"type": "token",
"documentation": "Processing priority requested"
},
{
"name": "use",
"definition": "http://hl7.org/fhir/SearchParameter/claim-use",
"type": "token",
"documentation": "The kind of financial resource"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/claim-provider",
"type": "reference",
"documentation": "Provider responsible for the claim"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/claim-identifier",
"type": "token",
"documentation": "The primary identifier of the financial resource"
}
]
},
{
"type": "ClaimResponse",
"profile": {
"reference": "http://hl7.org/fhir/ClaimResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/claimresponse-identifier",
"type": "token",
"documentation": "The identity of the insurer"
}
]
},
{
"type": "ClinicalImpression",
"profile": {
"reference": "http://hl7.org/fhir/ClinicalImpression"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "trigger",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-trigger",
"type": "reference",
"documentation": "Request or event that necessitated this assessment"
},
{
"name": "previous",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-previous",
"type": "reference",
"documentation": "Reference to last assessment"
},
{
"name": "problem",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-problem",
"type": "reference",
"documentation": "General assessment of patient state"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-date",
"type": "date",
"documentation": "When the assessment occurred"
},
{
"name": "ruledout",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-ruledout",
"type": "token",
"documentation": "Specific text of code for diagnosis"
},
{
"name": "assessor",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-assessor",
"type": "reference",
"documentation": "The clinician performing the assessment"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-patient",
"type": "reference",
"documentation": "The patient being asssesed"
},
{
"name": "trigger-code",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-trigger-code",
"type": "token",
"documentation": "Request or event that necessitated this assessment"
},
{
"name": "resolved",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-resolved",
"type": "token",
"documentation": "Diagnosies/conditions resolved since previous assessment"
},
{
"name": "plan",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-plan",
"type": "reference",
"documentation": "Plan of action after assessment"
},
{
"name": "finding",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-finding",
"type": "token",
"documentation": "Specific text or code for finding"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-action",
"type": "reference",
"documentation": "Actions taken during assessment"
},
{
"name": "investigation",
"definition": "http://hl7.org/fhir/SearchParameter/clinicalimpression-investigation",
"type": "reference",
"documentation": "Record of a specific investigation"
}
]
},
{
"type": "Communication",
"profile": {
"reference": "http://hl7.org/fhir/Communication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/communication-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "sent",
"definition": "http://hl7.org/fhir/SearchParameter/communication-sent",
"type": "date",
"documentation": "When sent"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/communication-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/communication-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/communication-status",
"type": "token",
"documentation": "in-progress | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/communication-subject",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "received",
"definition": "http://hl7.org/fhir/SearchParameter/communication-received",
"type": "date",
"documentation": "When received"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/communication-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/communication-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/communication-medium",
"type": "token",
"documentation": "Communication medium"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/communication-recipient",
"type": "reference",
"documentation": "Message recipient"
}
]
},
{
"type": "CommunicationRequest",
"profile": {
"reference": "http://hl7.org/fhir/CommunicationRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-requester",
"type": "reference",
"documentation": "Requester of communication"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-status",
"type": "token",
"documentation": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-subject",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-encounter",
"type": "reference",
"documentation": "Encounter leading to message"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-recipient",
"type": "reference",
"documentation": "Message recipient"
},
{
"name": "medium",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-medium",
"type": "token",
"documentation": "Communication medium"
},
{
"name": "sender",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-sender",
"type": "reference",
"documentation": "Message sender"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-category",
"type": "token",
"documentation": "Message category"
},
{
"name": "time",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-time",
"type": "date",
"documentation": "When scheduled"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-patient",
"type": "reference",
"documentation": "Focus of message"
},
{
"name": "ordered",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-ordered",
"type": "date",
"documentation": "When ordered or proposed"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-priority",
"type": "token",
"documentation": "Message urgency"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/communicationrequest-identifier",
"type": "token",
"documentation": "Unique identifier"
}
]
},
{
"type": "Composition",
"profile": {
"reference": "http://hl7.org/fhir/Composition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "section-code",
"definition": "http://hl7.org/fhir/SearchParameter/composition-section-code",
"type": "token",
"documentation": "Classification of section (recommended)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/composition-status",
"type": "token",
"documentation": "preliminary | final | appended | amended | entered-in-error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/composition-subject",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/composition-class",
"type": "token",
"documentation": "Categorization of Composition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/composition-encounter",
"type": "reference",
"documentation": "Context of the conposition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/composition-type",
"type": "token",
"documentation": "Kind of composition (LOINC if possible)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/composition-date",
"type": "date",
"documentation": "Composition editing time"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/composition-period",
"type": "date",
"documentation": "The period covered by the documentation"
},
{
"name": "section",
"definition": "http://hl7.org/fhir/SearchParameter/composition-section",
"type": "reference",
"documentation": "The Content of the section (narrative + data entries)"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/composition-author",
"type": "reference",
"documentation": "Who and/or what authored the composition"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/composition-title",
"type": "string",
"documentation": "Human Readable name/title"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/composition-patient",
"type": "reference",
"documentation": "Who and/or what the composition is about"
},
{
"name": "attester",
"definition": "http://hl7.org/fhir/SearchParameter/composition-attester",
"type": "reference",
"documentation": "Who attested the composition"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/composition-confidentiality",
"type": "token",
"documentation": "As defined by affinity domain"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/composition-context",
"type": "token",
"documentation": "Code(s) that apply to the event being documented"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/composition-identifier",
"type": "token",
"documentation": "Logical identifier of composition (version-independent)"
}
]
},
{
"type": "ConceptMap",
"profile": {
"reference": "http://hl7.org/fhir/ConceptMap"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "dependson",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-dependson",
"type": "uri",
"documentation": "Reference to element/field/valueset mapping depends on"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-status",
"type": "token",
"documentation": "Status of the concept map"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-date",
"type": "date",
"documentation": "The concept map publication date"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-url",
"type": "uri",
"documentation": "The url of the concept map"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-version",
"type": "token",
"documentation": "The version identifier of the concept map"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-publisher",
"type": "string",
"documentation": "Name of the publisher of the concept map"
},
{
"name": "product",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-product",
"type": "uri",
"documentation": "Reference to element/field/valueset mapping depends on"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-system",
"type": "uri",
"documentation": "The system for any destination concepts mapped by this map"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-source",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-description",
"type": "string",
"documentation": "Text search in the description of the concept map"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-name",
"type": "string",
"documentation": "Name of the concept map"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-context",
"type": "token",
"documentation": "A use context assigned to the concept map"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-target",
"type": "reference",
"documentation": "Provides context to the mappings"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/conceptmap-identifier",
"type": "token",
"documentation": "Additional identifier for the concept map"
}
]
},
{
"type": "Condition",
"profile": {
"reference": "http://hl7.org/fhir/Condition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "asserter",
"definition": "http://hl7.org/fhir/SearchParameter/condition-asserter",
"type": "reference",
"documentation": "Person who asserts this condition"
},
{
"name": "following-code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-following-code",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "dueto-code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-dueto-code",
"type": "token",
"documentation": "Relationship target by means of a predefined code"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/condition-location",
"type": "token",
"documentation": "Location - may include laterality"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/condition-subject",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "onset",
"definition": "http://hl7.org/fhir/SearchParameter/condition-onset",
"type": "date",
"documentation": "Date related onsets (dateTime and Period)"
},
{
"name": "evidence",
"definition": "http://hl7.org/fhir/SearchParameter/condition-evidence",
"type": "token",
"documentation": "Manifestation/symptom"
},
{
"name": "onset-info",
"definition": "http://hl7.org/fhir/SearchParameter/condition-onset-info",
"type": "string",
"documentation": "Other onsets (boolean, age, range, string)"
},
{
"name": "following-item",
"definition": "http://hl7.org/fhir/SearchParameter/condition-following-item",
"type": "reference",
"documentation": "Relationship target resource"
},
{
"name": "severity",
"definition": "http://hl7.org/fhir/SearchParameter/condition-severity",
"type": "token",
"documentation": "The severity of the condition"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/condition-code",
"type": "token",
"documentation": "Code for the condition"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/condition-encounter",
"type": "reference",
"documentation": "Encounter when condition first asserted"
},
{
"name": "date-asserted",
"definition": "http://hl7.org/fhir/SearchParameter/condition-date-asserted",
"type": "date",
"documentation": "When first detected/suspected/entered"
},
{
"name": "stage",
"definition": "http://hl7.org/fhir/SearchParameter/condition-stage",
"type": "token",
"documentation": "Simple summary (disease specific)"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/condition-category",
"type": "token",
"documentation": "The category of the condition"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/condition-patient",
"type": "reference",
"documentation": "Who has the condition?"
},
{
"name": "dueto-item",
"definition": "http://hl7.org/fhir/SearchParameter/condition-dueto-item",
"type": "reference",
"documentation": "Relationship target resource"
},
{
"name": "clinicalstatus",
"definition": "http://hl7.org/fhir/SearchParameter/condition-clinicalstatus",
"type": "token",
"documentation": "The clinical status of the condition"
}
]
},
{
"type": "Conformance",
"profile": {
"reference": "http://hl7.org/fhir/Conformance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
"type": "token",
"documentation": "The current status of the conformance statement"
},
{
"name": "resource",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-resource",
"type": "token",
"documentation": "Name of a resource mentioned in a conformance statement"
},
{
"name": "security",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-security",
"type": "token",
"documentation": "Information about security of implementation"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-format",
"type": "token",
"documentation": "formats supported (xml | json | mime type)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
"type": "date",
"documentation": "The conformance statement publication date"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
"type": "uri",
"documentation": "The uri that identifies the conformance statement"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
"type": "token",
"documentation": "The version identifier of the conformance statement"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-publisher",
"type": "string",
"documentation": "Name of the publisher of the conformance statement"
},
{
"name": "mode",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-mode",
"type": "token",
"documentation": "Mode - restful (server/client) or messaging (sender/receiver)"
},
{
"name": "software",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-software",
"type": "string",
"documentation": "Part of a the name of a software application"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
"type": "string",
"documentation": "Text search in the description of the conformance statement"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-event",
"type": "token",
"documentation": "Event code in a conformance statement"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
"type": "string",
"documentation": "Name of the conformance statement"
},
{
"name": "supported-profile",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-supported-profile",
"type": "reference",
"documentation": "Profiles supported by the system"
},
{
"name": "fhirversion",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-fhirversion",
"type": "token",
"documentation": "The version of FHIR"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/SearchParameter/conformance-profile",
"type": "reference",
"documentation": "A profile id invoked in a conformance statement"
}
]
},
{
"type": "Contract",
"profile": {
"reference": "http://hl7.org/fhir/Contract"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "signer",
"definition": "http://hl7.org/fhir/SearchParameter/contract-signer",
"type": "reference",
"documentation": "Contract Signatory Party"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/contract-patient",
"type": "reference",
"documentation": "The identity of the target of the contract (if a patient)"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/contract-subject",
"type": "reference",
"documentation": "The identity of the target of the contract"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/contract-actor",
"type": "reference",
"documentation": "Contract Actor Type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/contract-identifier",
"type": "token",
"documentation": "The identity of the contract"
}
]
},
{
"type": "Contraindication",
"profile": {
"reference": "http://hl7.org/fhir/Contraindication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-author",
"type": "reference",
"documentation": "Who found issue?"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-category",
"type": "token",
"documentation": "E.g. Drug-drug, duplicate therapy, etc."
},
{
"name": "implicated",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-implicated",
"type": "reference",
"documentation": "Problem resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-patient",
"type": "reference",
"documentation": "Associated patient"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-date",
"type": "date",
"documentation": "When identified"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/contraindication-identifier",
"type": "token",
"documentation": "Unique id for the contraindication"
}
]
},
{
"type": "Coverage",
"profile": {
"reference": "http://hl7.org/fhir/Coverage"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "plan",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-plan",
"type": "token",
"documentation": "A plan or policy identifier"
},
{
"name": "issuer",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-issuer",
"type": "reference",
"documentation": "The identity of the insurer"
},
{
"name": "sequence",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-sequence",
"type": "token",
"documentation": "Sequence number"
},
{
"name": "dependent",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-dependent",
"type": "token",
"documentation": "Dependent number"
},
{
"name": "group",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-group",
"type": "token",
"documentation": "Group identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-type",
"type": "token",
"documentation": "The kind of coverage"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-identifier",
"type": "token",
"documentation": "The primary identifier of the insured"
},
{
"name": "subplan",
"definition": "http://hl7.org/fhir/SearchParameter/coverage-subplan",
"type": "token",
"documentation": "Sub-plan identifier"
}
]
},
{
"type": "DataElement",
"profile": {
"reference": "http://hl7.org/fhir/DataElement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-status",
"type": "token",
"documentation": "The current status of the data element"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-description",
"type": "string",
"documentation": "Text search in the description of the data element. This corresponds to the definition of the first DataElement.element."
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-name",
"type": "string",
"documentation": "Name of the data element"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-context",
"type": "token",
"documentation": "A use context assigned to the data element"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-code",
"type": "token",
"documentation": "A code for the data element (server may choose to do subsumption)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-date",
"type": "date",
"documentation": "The data element publication date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-identifier",
"type": "token",
"documentation": "The identifier of the data element"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-url",
"type": "uri",
"documentation": "The official URL for the data element"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-publisher",
"type": "string",
"documentation": "Name of the publisher of the data element"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/dataelement-version",
"type": "string",
"documentation": "The version identifier of the data element"
}
]
},
{
"type": "Device",
"profile": {
"reference": "http://hl7.org/fhir/Device"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/device-organization",
"type": "reference",
"documentation": "The organization responsible for the device"
},
{
"name": "model",
"definition": "http://hl7.org/fhir/SearchParameter/device-model",
"type": "string",
"documentation": "The model of the device"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/device-patient",
"type": "reference",
"documentation": "Patient information, if the resource is affixed to a person"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/device-location",
"type": "reference",
"documentation": "A location, where the resource is found"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/device-manufacturer",
"type": "string",
"documentation": "The manufacturer of the device"
},
{
"name": "udi",
"definition": "http://hl7.org/fhir/SearchParameter/device-udi",
"type": "string",
"documentation": "FDA Mandated Unique Device Identifier"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/device-type",
"type": "token",
"documentation": "The type of the device"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/device-identifier",
"type": "token",
"documentation": "Instance id from manufacturer, owner, and others"
}
]
},
{
"type": "DeviceComponent",
"profile": {
"reference": "http://hl7.org/fhir/DeviceComponent"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/devicecomponent-source",
"type": "reference",
"documentation": "The device source"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/devicecomponent-parent",
"type": "reference",
"documentation": "The parent DeviceComponent resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/devicecomponent-type",
"type": "token",
"documentation": "The device component type"
}
]
},
{
"type": "DeviceMetric",
"profile": {
"reference": "http://hl7.org/fhir/DeviceMetric"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-category",
"type": "token",
"documentation": "The category of the metric"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-source",
"type": "reference",
"documentation": "The device resource"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-parent",
"type": "reference",
"documentation": "The parent DeviceMetric resource"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-type",
"type": "token",
"documentation": "The component type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/devicemetric-identifier",
"type": "token",
"documentation": "The identifier of the metric"
}
]
},
{
"type": "DeviceUseRequest",
"profile": {
"reference": "http://hl7.org/fhir/DeviceUseRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/deviceuserequest-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/deviceuserequest-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/deviceuserequest-device",
"type": "reference",
"documentation": "Device requested"
}
]
},
{
"type": "DeviceUseStatement",
"profile": {
"reference": "http://hl7.org/fhir/DeviceUseStatement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/deviceusestatement-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/deviceusestatement-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/deviceusestatement-device",
"type": "reference",
"documentation": "Search by device"
}
]
},
{
"type": "DiagnosticOrder",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticOrder"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "orderer",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-orderer",
"type": "reference",
"documentation": "Who ordered the test"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-status",
"type": "token",
"documentation": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-subject",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "item-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-status",
"type": "token",
"documentation": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed"
},
{
"name": "event-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-status",
"type": "token",
"documentation": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed"
},
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-actor",
"type": "reference",
"documentation": "Who recorded or did this"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-code",
"type": "token",
"documentation": "Code to indicate the item (test or panel) being ordered"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-encounter",
"type": "reference",
"documentation": "The encounter that this diagnostic order is associated with"
},
{
"name": "item-past-status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-past-status",
"type": "token",
"documentation": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-patient",
"type": "reference",
"documentation": "Who and/or what test is about"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-bodysite",
"type": "token",
"documentation": "Location of requested test (if applicable)"
},
{
"name": "item-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-date",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-specimen",
"type": "reference",
"documentation": "If the whole order relates to specific specimens"
},
{
"name": "event-status-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-status-date",
"type": "composite",
"documentation": "A combination of past-status and date"
},
{
"name": "event-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-event-date",
"type": "date",
"documentation": "The date at which the event happened"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-identifier",
"type": "token",
"documentation": "Identifiers assigned to this order"
},
{
"name": "item-status-date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticorder-item-status-date",
"type": "composite",
"documentation": "A combination of item-past-status and item-date"
}
]
},
{
"type": "DiagnosticReport",
"profile": {
"reference": "http://hl7.org/fhir/DiagnosticReport"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "result",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-result",
"type": "reference",
"documentation": "Link to an atomic result (observation resource)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-status",
"type": "token",
"documentation": "The status of the report"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-subject",
"type": "reference",
"documentation": "The subject of the report"
},
{
"name": "issued",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-issued",
"type": "date",
"documentation": "When the report was issued"
},
{
"name": "diagnosis",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-diagnosis",
"type": "token",
"documentation": "A coded diagnosis on the report"
},
{
"name": "image",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-image",
"type": "reference",
"documentation": "Reference to the image source"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-encounter",
"type": "reference",
"documentation": "The Encounter when the order was made"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-date",
"type": "date",
"documentation": "The clinically relevant time of the report"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-patient",
"type": "reference",
"documentation": "The subject of the report if a patient"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-specimen",
"type": "reference",
"documentation": "The specimen details"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-name",
"type": "token",
"documentation": "The name of the report (e.g. the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result)"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-request",
"type": "reference",
"documentation": "What was requested"
},
{
"name": "service",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-service",
"type": "token",
"documentation": "Which diagnostic discipline/department created the report"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-performer",
"type": "reference",
"documentation": "Who was the source of the report (organization)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/diagnosticreport-identifier",
"type": "token",
"documentation": "An identifier for the report"
}
]
},
{
"type": "DocumentManifest",
"profile": {
"reference": "http://hl7.org/fhir/DocumentManifest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-status",
"type": "token",
"documentation": "current | superceded | entered-in-error"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-subject",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-type",
"type": "token",
"documentation": "What kind of document set this is"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-recipient",
"type": "reference",
"documentation": "Intended to get notified about this set of documents"
},
{
"name": "relatedid",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-relatedid",
"type": "token",
"documentation": "Related Identifier"
},
{
"name": "content",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-content",
"type": "reference",
"documentation": "Contents of this set of documents"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "relatedref",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-relatedref",
"type": "reference",
"documentation": "Related Resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-patient",
"type": "reference",
"documentation": "The subject of the set of documents"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-source",
"type": "uri",
"documentation": "The source system/application/software"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-created",
"type": "date",
"documentation": "When this document manifest created"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-description",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/documentmanifest-identifier",
"type": "token",
"documentation": "Unique Identifier for the set of documents"
}
]
},
{
"type": "DocumentReference",
"profile": {
"reference": "http://hl7.org/fhir/DocumentReference"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "indexed",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-indexed",
"type": "date",
"documentation": "When this document reference created"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-location",
"type": "uri",
"documentation": "Uri where the data can be found"
},
{
"name": "relatesto",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relatesto",
"type": "reference",
"documentation": "Target of the relationship"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-subject",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-type",
"type": "token",
"documentation": "Precise type of document"
},
{
"name": "relatedid",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relatedid",
"type": "token",
"documentation": "Related Identifier"
},
{
"name": "setting",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-setting",
"type": "token",
"documentation": "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-author",
"type": "reference",
"documentation": "Who and/or what authored the document"
},
{
"name": "custodian",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-custodian",
"type": "reference",
"documentation": "Org which maintains the document"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-patient",
"type": "reference",
"documentation": "Who|what is the subject of the document"
},
{
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-facility",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-created",
"type": "date",
"documentation": "Document creation time"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-description",
"type": "string",
"documentation": "Human-readable description (title)"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-event",
"type": "token",
"documentation": "Main Clinical Acts Documented"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-status",
"type": "token",
"documentation": "current | superceded | entered-in-error"
},
{
"name": "relation",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relation",
"type": "token",
"documentation": "replaces | transforms | signs | appends"
},
{
"name": "class",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-class",
"type": "token",
"documentation": "High-level classification of document"
},
{
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-format",
"type": "uri",
"documentation": "Format/content rules for the document"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-period",
"type": "date",
"documentation": "Time of service that is being documented"
},
{
"name": "authenticator",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-authenticator",
"type": "reference",
"documentation": "Who/What authenticated the document"
},
{
"name": "relationship",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relationship",
"type": "composite",
"documentation": "Combination of relation and relatesTo"
},
{
"name": "relatedref",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-relatedref",
"type": "reference",
"documentation": "Related Resource"
},
{
"name": "confidentiality",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-confidentiality",
"type": "token",
"documentation": "Document security-tags"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-language",
"type": "token",
"documentation": "Human language of the content (BCP-47)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/documentreference-identifier",
"type": "token",
"documentation": "Master Version Specific Identifier"
}
]
},
{
"type": "EligibilityRequest",
"profile": {
"reference": "http://hl7.org/fhir/EligibilityRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/eligibilityrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "EligibilityResponse",
"profile": {
"reference": "http://hl7.org/fhir/EligibilityResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/eligibilityresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "Encounter",
"profile": {
"reference": "http://hl7.org/fhir/Encounter"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "participant-type",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-participant-type",
"type": "token",
"documentation": "Role of participant in encounter"
},
{
"name": "episodeofcare",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-episodeofcare",
"type": "reference",
"documentation": "An episode of care that this encounter should be recorded against"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-status",
"type": "token",
"documentation": "planned | arrived | in-progress | onleave | finished | cancelled"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-reason",
"type": "token",
"documentation": "Reason the encounter takes place (code)"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-location",
"type": "reference",
"documentation": "Location the encounter takes place"
},
{
"name": "fulfills",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-fulfills",
"type": "reference",
"documentation": "The appointment that scheduled this encounter"
},
{
"name": "indication",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-indication",
"type": "reference",
"documentation": "Reason the encounter takes place (resource)"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-date",
"type": "date",
"documentation": "A date within the period the Encounter lasted"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-type",
"type": "token",
"documentation": "Specific type of encounter"
},
{
"name": "special-arrangement",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-special-arrangement",
"type": "token",
"documentation": "Wheelchair, translator, stretcher, etc"
},
{
"name": "part-of",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-part-of",
"type": "reference",
"documentation": "Another Encounter this encounter is part of"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-patient",
"type": "reference",
"documentation": "The patient present at the encounter"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-practitioner",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
},
{
"name": "length",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-length",
"type": "number",
"documentation": "Length of encounter in days"
},
{
"name": "participant",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-participant",
"type": "reference",
"documentation": "Persons involved in the encounter other than the patient"
},
{
"name": "incomingreferral",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-incomingreferral",
"type": "reference",
"documentation": "Incoming Referral Request"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-identifier",
"type": "token",
"documentation": "Identifier(s) by which this encounter is known"
},
{
"name": "location-period",
"definition": "http://hl7.org/fhir/SearchParameter/encounter-location-period",
"type": "date",
"documentation": "Time period during which the patient was present at the location"
}
]
},
{
"type": "EnrollmentRequest",
"profile": {
"reference": "http://hl7.org/fhir/EnrollmentRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-patient",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-subject",
"type": "reference",
"documentation": "The party to be enrolled"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentrequest-identifier",
"type": "token",
"documentation": "The business identifier of the Enrollment"
}
]
},
{
"type": "EnrollmentResponse",
"profile": {
"reference": "http://hl7.org/fhir/EnrollmentResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/enrollmentresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "EpisodeOfCare",
"profile": {
"reference": "http://hl7.org/fhir/EpisodeOfCare"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-organization",
"type": "reference",
"documentation": "The organization that has assumed the specific responsibilities of this EpisodeOfCare"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-patient",
"type": "reference",
"documentation": "The patient that this EpisodeOfCare applies to"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-condition",
"type": "reference",
"documentation": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-status",
"type": "token",
"documentation": "The current status of the Episode of Care as provided (does not check the status history collection)"
},
{
"name": "care-manager",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-care-manager",
"type": "reference",
"documentation": "The practitioner that is the care manager/care co-ordinator for this patient"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-type",
"type": "token",
"documentation": "Specific type of EpisodeOfCare"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-date",
"type": "date",
"documentation": "The provided date search value falls within the episode of care's period"
},
{
"name": "incomingreferral",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-incomingreferral",
"type": "reference",
"documentation": "Incoming Referral Request"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-identifier",
"type": "token",
"documentation": "Identifier(s) by which this EpisodeOfCare is known"
},
{
"name": "team-member",
"definition": "http://hl7.org/fhir/SearchParameter/episodeofcare-team-member",
"type": "reference",
"documentation": "A Practitioner or Organization allocated to the care team for this EpisodeOfCare"
}
]
},
{
"type": "ExplanationOfBenefit",
"profile": {
"reference": "http://hl7.org/fhir/ExplanationOfBenefit"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/explanationofbenefit-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "FamilyHistory",
"profile": {
"reference": "http://hl7.org/fhir/FamilyHistory"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/familyhistory-patient",
"type": "reference",
"documentation": "The identity of a subject to list family history items for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/familyhistory-date",
"type": "date",
"documentation": "When history was captured/updated"
}
]
},
{
"type": "Goal",
"profile": {
"reference": "http://hl7.org/fhir/Goal"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/goal-patient",
"type": "reference",
"documentation": "The patient for whom this goal is intended for"
}
]
},
{
"type": "Group",
"profile": {
"reference": "http://hl7.org/fhir/Group"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "member",
"definition": "http://hl7.org/fhir/SearchParameter/group-member",
"type": "reference",
"documentation": "Who or what is in group"
},
{
"name": "characteristic-value",
"definition": "http://hl7.org/fhir/SearchParameter/group-characteristic-value",
"type": "composite",
"documentation": "A composite of both characteristic and value"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/group-value",
"type": "token",
"documentation": "Value held by characteristic"
},
{
"name": "actual",
"definition": "http://hl7.org/fhir/SearchParameter/group-actual",
"type": "token",
"documentation": "Descriptive or actual"
},
{
"name": "exclude",
"definition": "http://hl7.org/fhir/SearchParameter/group-exclude",
"type": "token",
"documentation": "Group includes or excludes"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/group-code",
"type": "token",
"documentation": "The kind of resources contained"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/group-characteristic",
"type": "token",
"documentation": "Kind of characteristic"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/group-type",
"type": "token",
"documentation": "The type of resources the group contains"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/group-identifier",
"type": "token",
"documentation": "Unique id"
}
]
},
{
"type": "HealthcareService",
"profile": {
"reference": "http://hl7.org/fhir/HealthcareService"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "servicecategory",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-servicecategory",
"type": "token",
"documentation": "Service Category of the Healthcare Service"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-organization",
"type": "reference",
"documentation": "The organization that provides this Healthcare Service"
},
{
"name": "servicetype",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-servicetype",
"type": "token",
"documentation": "The type of service provided by this healthcare service"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-location",
"type": "reference",
"documentation": "The location of the Healthcare Service"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-name",
"type": "string",
"documentation": "A portion of the Healthcare service name"
},
{
"name": "programname",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-programname",
"type": "string",
"documentation": "One of the Program Names serviced by this HealthcareService"
},
{
"name": "characteristic",
"definition": "http://hl7.org/fhir/SearchParameter/healthcareservice-characteristic",
"type": "token",
"documentation": "One of the HealthcareService's characteristics"
}
]
},
{
"type": "ImagingObjectSelection",
"profile": {
"reference": "http://hl7.org/fhir/ImagingObjectSelection"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "selected-study",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-selected-study",
"type": "token",
"documentation": "Study selected in key DICOM object selection"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-author",
"type": "reference",
"documentation": "Author of key DICOM object selection"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-title",
"type": "token",
"documentation": "Title of key DICOM object selection"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-patient",
"type": "reference",
"documentation": "Subject of key DICOM object selection"
},
{
"name": "authoring-time",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-authoring-time",
"type": "date",
"documentation": "Time of key DICOM object selection authoring"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/imagingobjectselection-identifier",
"type": "token",
"documentation": "UID of key DICOM object selection"
}
]
},
{
"type": "ImagingStudy",
"profile": {
"reference": "http://hl7.org/fhir/ImagingStudy"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "uid",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-uid",
"type": "token",
"documentation": "Formal identifier for this instance (0008,0018)"
},
{
"name": "series",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-series",
"type": "token",
"documentation": "The series id for the image"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-patient",
"type": "reference",
"documentation": "Who the study is about"
},
{
"name": "order",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-order",
"type": "reference",
"documentation": "The order for the image"
},
{
"name": "bodysite",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-bodysite",
"type": "token",
"documentation": "Body part examined (Map from 0018,0015)"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-accession",
"type": "token",
"documentation": "The accession id for the image"
},
{
"name": "study",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-study",
"type": "token",
"documentation": "The study id for the image"
},
{
"name": "modality",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-modality",
"type": "token",
"documentation": "The modality of the image"
},
{
"name": "started",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-started",
"type": "date",
"documentation": "When the study was started"
},
{
"name": "dicom-class",
"definition": "http://hl7.org/fhir/SearchParameter/imagingstudy-dicom-class",
"type": "token",
"documentation": "DICOM class type (0008,0016)"
}
]
},
{
"type": "Immunization",
"profile": {
"reference": "http://hl7.org/fhir/Immunization"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "reaction",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reaction",
"type": "reference",
"documentation": "Additional information on reaction"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-dose-sequence",
"type": "number",
"documentation": "What dose number within series?"
},
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-requester",
"type": "reference",
"documentation": "The practitioner who ordered the vaccination"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-vaccine-type",
"type": "token",
"documentation": "Vaccine Product Type Administered"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-location",
"type": "reference",
"documentation": "The service delivery location or facility in which the vaccine was / was to be administered"
},
{
"name": "reason",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reason",
"type": "token",
"documentation": "Why immunization occurred"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-subject",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "reaction-date",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reaction-date",
"type": "date",
"documentation": "When did reaction start?"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-notgiven",
"type": "token",
"documentation": "Administrations which were not given"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-date",
"type": "date",
"documentation": "Vaccination (non)-Administration Date"
},
{
"name": "reason-not-given",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-reason-not-given",
"type": "token",
"documentation": "Explanation of reason vaccination was not administered"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-patient",
"type": "reference",
"documentation": "The patient for the vaccination record"
},
{
"name": "lot-number",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-lot-number",
"type": "string",
"documentation": "Vaccine Lot Number"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-manufacturer",
"type": "reference",
"documentation": "Vaccine Manufacturer"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-performer",
"type": "reference",
"documentation": "The practitioner who administered the vaccination"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/immunization-identifier",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "ImmunizationRecommendation",
"profile": {
"reference": "http://hl7.org/fhir/ImmunizationRecommendation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "information",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-information",
"type": "reference",
"documentation": "Patient observations supporting recommendation"
},
{
"name": "dose-sequence",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-dose-sequence",
"type": "token",
"documentation": "Number of dose within sequence"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-patient",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "support",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-support",
"type": "reference",
"documentation": "Past immunizations supporting recommendation"
},
{
"name": "vaccine-type",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-vaccine-type",
"type": "token",
"documentation": "Vaccine recommendation applies to"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-status",
"type": "token",
"documentation": "Vaccine administration status"
},
{
"name": "dose-number",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-dose-number",
"type": "number",
"documentation": "Recommended dose number"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-subject",
"type": "reference",
"documentation": "Who this profile is for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-date",
"type": "date",
"documentation": "Date recommendation created"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/immunizationrecommendation-identifier",
"type": "token",
"documentation": "Business identifier"
}
]
},
{
"type": "List",
"profile": {
"reference": "http://hl7.org/fhir/List"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/list-patient",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/list-source",
"type": "reference",
"documentation": "Who and/or what defined the list contents"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/list-subject",
"type": "reference",
"documentation": "If all resources have the same subject"
},
{
"name": "item",
"definition": "http://hl7.org/fhir/SearchParameter/list-item",
"type": "reference",
"documentation": "Actual entry"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/list-code",
"type": "token",
"documentation": "What the purpose of this list is"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/list-date",
"type": "date",
"documentation": "When the list was prepared"
},
{
"name": "empty-reason",
"definition": "http://hl7.org/fhir/SearchParameter/list-empty-reason",
"type": "token",
"documentation": "Why list is empty"
}
]
},
{
"type": "Location",
"profile": {
"reference": "http://hl7.org/fhir/Location"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/location-organization",
"type": "reference",
"documentation": "Searches for locations that are managed by the provided organization"
},
{
"name": "near",
"definition": "http://hl7.org/fhir/SearchParameter/location-near",
"type": "token",
"documentation": "The coordinates expressed as [lat],[long] (using the WGS84 datum, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/location-partof",
"type": "reference",
"documentation": "The location of which this location is a part"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/location-status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/location-address",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/location-name",
"type": "string",
"documentation": "A (portion of the) name of the location"
},
{
"name": "near-distance",
"definition": "http://hl7.org/fhir/SearchParameter/location-near-distance",
"type": "token",
"documentation": "A distance quantity to limit the near search to locations within a specific distance"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/location-type",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/location-identifier",
"type": "token",
"documentation": "Unique code or number identifying the location to its users"
}
]
},
{
"type": "Media",
"profile": {
"reference": "http://hl7.org/fhir/Media"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/media-patient",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/media-created",
"type": "date",
"documentation": "Date attachment was first created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/media-subject",
"type": "reference",
"documentation": "Who/What this Media is a record of"
},
{
"name": "subtype",
"definition": "http://hl7.org/fhir/SearchParameter/media-subtype",
"type": "token",
"documentation": "The type of acquisition equipment/process"
},
{
"name": "view",
"definition": "http://hl7.org/fhir/SearchParameter/media-view",
"type": "token",
"documentation": "Imaging view e.g Lateral or Antero-posterior"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/media-type",
"type": "token",
"documentation": "photo | video | audio"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/media-identifier",
"type": "token",
"documentation": "Identifier(s) for the image"
},
{
"name": "operator",
"definition": "http://hl7.org/fhir/SearchParameter/media-operator",
"type": "reference",
"documentation": "The person who generated the image"
}
]
},
{
"type": "Medication",
"profile": {
"reference": "http://hl7.org/fhir/Medication"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "content",
"definition": "http://hl7.org/fhir/SearchParameter/medication-content",
"type": "reference",
"documentation": "A product in the package"
},
{
"name": "form",
"definition": "http://hl7.org/fhir/SearchParameter/medication-form",
"type": "token",
"documentation": "powder | tablets | carton +"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/medication-container",
"type": "token",
"documentation": "E.g. box, vial, blister-pack"
},
{
"name": "manufacturer",
"definition": "http://hl7.org/fhir/SearchParameter/medication-manufacturer",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/medication-name",
"type": "string",
"documentation": "Common / Commercial name"
},
{
"name": "ingredient",
"definition": "http://hl7.org/fhir/SearchParameter/medication-ingredient",
"type": "reference",
"documentation": "The product contained"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/medication-code",
"type": "token",
"documentation": "Codes that identify this medication"
}
]
},
{
"type": "MedicationAdministration",
"profile": {
"reference": "http://hl7.org/fhir/MedicationAdministration"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-medication",
"type": "reference",
"documentation": "Return administrations of this medication"
},
{
"name": "effectivetime",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-effectivetime",
"type": "date",
"documentation": "Date administration happened (or did not happen)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-practitioner",
"type": "reference",
"documentation": "Who administered substance?"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-status",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-device",
"type": "reference",
"documentation": "Return administrations with this administration device identity"
},
{
"name": "notgiven",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-notgiven",
"type": "token",
"documentation": "Administrations that were not made"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-encounter",
"type": "reference",
"documentation": "Return administrations that share this encounter"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationadministration-identifier",
"type": "token",
"documentation": "Return administrations with this external identity"
}
]
},
{
"type": "MedicationDispense",
"profile": {
"reference": "http://hl7.org/fhir/MedicationDispense"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-medication",
"type": "reference",
"documentation": "Returns dispenses of this medicine"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-receiver",
"type": "reference",
"documentation": "Who collected the medication"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-status",
"type": "token",
"documentation": "Status of the dispense"
},
{
"name": "prescription",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-prescription",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from"
},
{
"name": "responsibleparty",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-responsibleparty",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party"
},
{
"name": "dispenser",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-dispenser",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-type",
"type": "token",
"documentation": "Return all dispenses of a specific type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-identifier",
"type": "token",
"documentation": "Return dispenses with this external identity"
},
{
"name": "whenprepared",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-whenprepared",
"type": "date",
"documentation": "Date when medication prepared"
},
{
"name": "whenhandedover",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-whenhandedover",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/medicationdispense-destination",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination"
}
]
},
{
"type": "MedicationPrescription",
"profile": {
"reference": "http://hl7.org/fhir/MedicationPrescription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-status",
"type": "token",
"documentation": "Status of the prescription"
},
{
"name": "prescriber",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-prescriber",
"type": "reference",
"documentation": "Who ordered the medication(s)"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationprescription-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
},
{
"type": "MedicationStatement",
"profile": {
"reference": "http://hl7.org/fhir/MedicationStatement"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "medication",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-medication",
"type": "reference",
"documentation": "Code for medicine or text in medicine name"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-patient",
"type": "reference",
"documentation": "The identity of a patient to list statements for"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-source",
"type": "reference",
"documentation": "Who the information in the statement came from"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-status",
"type": "token",
"documentation": "Return statements that match the given status"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-identifier",
"type": "token",
"documentation": "Return statements with this external identity"
},
{
"name": "effectivedate",
"definition": "http://hl7.org/fhir/SearchParameter/medicationstatement-effectivedate",
"type": "date",
"documentation": "Date when patient was taking (or not taking) the medication"
}
]
},
{
"type": "MessageHeader",
"profile": {
"reference": "http://hl7.org/fhir/MessageHeader"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "destination-uri",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-destination-uri",
"type": "uri",
"documentation": "Actual destination address or id"
},
{
"name": "receiver",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-receiver",
"type": "reference",
"documentation": "Intended \"real-world\" recipient for the data"
},
{
"name": "responsible",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-responsible",
"type": "reference",
"documentation": "Final responsibility for event"
},
{
"name": "data",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-data",
"type": "reference",
"documentation": "The actual content of the message"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-code",
"type": "token",
"documentation": "ok | transient-error | fatal-error"
},
{
"name": "response-id",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-response-id",
"type": "token",
"documentation": "Id of original message"
},
{
"name": "src-id",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-src-id",
"type": "token",
"documentation": "Id of this message"
},
{
"name": "destination",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-destination",
"type": "string",
"documentation": "Name of system"
},
{
"name": "timestamp",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-timestamp",
"type": "date",
"documentation": "Time that the message was sent"
},
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-author",
"type": "reference",
"documentation": "The source of the decision"
},
{
"name": "source-uri",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-source-uri",
"type": "uri",
"documentation": "Actual message source address or id"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-source",
"type": "string",
"documentation": "Name of system"
},
{
"name": "enterer",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-enterer",
"type": "reference",
"documentation": "The source of the data entry"
},
{
"name": "event",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-event",
"type": "token",
"documentation": "Code for the event this message represents"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/messageheader-target",
"type": "reference",
"documentation": "Particular delivery destination within the destination"
}
]
},
{
"type": "NamingSystem",
"profile": {
"reference": "http://hl7.org/fhir/NamingSystem"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "responsible",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-responsible",
"type": "string",
"documentation": "Who maintains system namespace?"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-status",
"type": "token",
"documentation": "draft | active | retired"
},
{
"name": "idtype",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-idtype",
"type": "token",
"documentation": "oid | uuid | uri | other"
},
{
"name": "replacedby",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-replacedby",
"type": "reference",
"documentation": "Use this instead"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-type",
"type": "token",
"documentation": "codesystem | identifier | root"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-date",
"type": "date",
"documentation": "Publication Date(/time)"
},
{
"name": "period",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-period",
"type": "date",
"documentation": "When is identifier valid?"
},
{
"name": "contact",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-contact",
"type": "string",
"documentation": "Name of a individual to contact"
},
{
"name": "country",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-country",
"type": "token",
"documentation": "ISO 3-char country code"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-publisher",
"type": "string",
"documentation": "Name of the publisher (Organization or individual)"
},
{
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-category",
"type": "token",
"documentation": "e.g. driver, provider, patient, bank etc"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-name",
"type": "string",
"documentation": "Human-readable label"
},
{
"name": "value",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-value",
"type": "string",
"documentation": "The unique identifier"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/namingsystem-telecom",
"type": "token",
"documentation": "Contact details for individual or publisher"
}
]
},
{
"type": "NutritionOrder",
"profile": {
"reference": "http://hl7.org/fhir/NutritionOrder"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-patient",
"type": "reference",
"documentation": "The identity of the person who requires the diet, formula or nutritional supplement"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-status",
"type": "token",
"documentation": "Status of the nutrition order."
},
{
"name": "supplement",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-supplement",
"type": "token",
"documentation": "Type of supplement product requested"
},
{
"name": "oraldiet",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-oraldiet",
"type": "token",
"documentation": "Type of diet that can be consumed orally (i.e., take via the mouth)."
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-provider",
"type": "reference",
"documentation": "The identify of the provider who placed the nutrition order"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-encounter",
"type": "reference",
"documentation": "Return nutrition orders with this encounter identity"
},
{
"name": "datetime",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-datetime",
"type": "date",
"documentation": "Return nutrition orders requested on this date"
},
{
"name": "additive",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-additive",
"type": "token",
"documentation": "Type of module component to add to the feeding"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-identifier",
"type": "token",
"documentation": "Return nutrition orders with this external identity"
},
{
"name": "formula",
"definition": "http://hl7.org/fhir/SearchParameter/nutritionorder-formula",
"type": "token",
"documentation": "Type of enteral or infant formula"
}
]
},
{
"type": "Observation",
"profile": {
"reference": "http://hl7.org/fhir/Observation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "value-string",
"definition": "http://hl7.org/fhir/SearchParameter/observation-value-string",
"type": "string",
"documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/observation-status",
"type": "token",
"documentation": "The status of the observation"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/observation-subject",
"type": "reference",
"documentation": "The subject that the observation is about"
},
{
"name": "value-concept",
"definition": "http://hl7.org/fhir/SearchParameter/observation-value-concept",
"type": "token",
"documentation": "The value of the observation, if the value is a CodeableConcept"
},
{
"name": "reliability",
"definition": "http://hl7.org/fhir/SearchParameter/observation-reliability",
"type": "token",
"documentation": "The reliability of the observation"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/observation-encounter",
"type": "reference",
"documentation": "Healthcare event related to the observation"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/observation-code",
"type": "token",
"documentation": "The code of the observation type"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/observation-date",
"type": "date",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
},
{
"name": "related-target",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related-target",
"type": "reference",
"documentation": "Observation that is related to this one"
},
{
"name": "data-absent-reason",
"definition": "http://hl7.org/fhir/SearchParameter/observation-data-absent-reason",
"type": "token",
"documentation": "The reason why the expected value in the element Observation.value[x] is missing."
},
{
"name": "related",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related",
"type": "composite",
"documentation": "Related Observations - search on related-type and related-target together"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/observation-patient",
"type": "reference",
"documentation": "The subject that the observation is about (if patient)"
},
{
"name": "specimen",
"definition": "http://hl7.org/fhir/SearchParameter/observation-specimen",
"type": "reference",
"documentation": "Specimen used for this observation"
},
{
"name": "device",
"definition": "http://hl7.org/fhir/SearchParameter/observation-device",
"type": "reference",
"documentation": "The Device that generated the observation data."
},
{
"name": "related-type",
"definition": "http://hl7.org/fhir/SearchParameter/observation-related-type",
"type": "token",
"documentation": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/observation-performer",
"type": "reference",
"documentation": "Who performed the observation"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/observation-identifier",
"type": "token",
"documentation": "The unique Id for a particular observation"
},
{
"name": "value-quantity",
"definition": "http://hl7.org/fhir/SearchParameter/observation-value-quantity",
"type": "quantity",
"documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
},
{
"name": "code-value-[x]",
"definition": "http://hl7.org/fhir/SearchParameter/observation-code-value",
"type": "composite",
"documentation": "Both code and one of the value parameters"
},
{
"name": "value-date",
"definition": "http://hl7.org/fhir/SearchParameter/observation-value-date",
"type": "date",
"documentation": "The value of the observation, if the value is a Period"
}
]
},
{
"type": "OperationDefinition",
"profile": {
"reference": "http://hl7.org/fhir/OperationDefinition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-status",
"type": "token",
"documentation": "draft | active | retired"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-code",
"type": "token",
"documentation": "Name used to invoke the operation"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-date",
"type": "date",
"documentation": "Date for this version of the operation definition"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-type",
"type": "token",
"documentation": "Invoke at resource level for these type"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-url",
"type": "uri",
"documentation": "Logical url to reference this operation definition"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-kind",
"type": "token",
"documentation": "operation | query"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-version",
"type": "token",
"documentation": "Logical id for this version of the operation definition"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-publisher",
"type": "string",
"documentation": "Name of the publisher (Organization or individual)"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-system",
"type": "token",
"documentation": "Invoke at the system level?"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-name",
"type": "string",
"documentation": "Informal name for this profile"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-base",
"type": "reference",
"documentation": "Marks this as a profile of the base"
},
{
"name": "instance",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-instance",
"type": "token",
"documentation": "Invoke on an instance?"
},
{
"name": "profile",
"definition": "http://hl7.org/fhir/SearchParameter/operationdefinition-profile",
"type": "reference",
"documentation": "Profile on the type"
}
]
},
{
"type": "OperationOutcome",
"profile": {
"reference": "http://hl7.org/fhir/OperationOutcome"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
]
},
{
"type": "Order",
"profile": {
"reference": "http://hl7.org/fhir/Order"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "authority",
"definition": "http://hl7.org/fhir/SearchParameter/order-authority",
"type": "reference",
"documentation": "If required by policy"
},
{
"name": "detail",
"definition": "http://hl7.org/fhir/SearchParameter/order-detail",
"type": "reference",
"documentation": "What action is being ordered"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/order-patient",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/order-source",
"type": "reference",
"documentation": "Who initiated the order"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/order-subject",
"type": "reference",
"documentation": "Patient this order is about"
},
{
"name": "when",
"definition": "http://hl7.org/fhir/SearchParameter/order-when",
"type": "date",
"documentation": "A formal schedule"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/order-target",
"type": "reference",
"documentation": "Who is intended to fulfill the order"
},
{
"name": "when_code",
"definition": "http://hl7.org/fhir/SearchParameter/order-when_code",
"type": "token",
"documentation": "Code specifies when request should be done. The code may simply be a priority code"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/order-date",
"type": "date",
"documentation": "When the order was made"
}
]
},
{
"type": "OrderResponse",
"profile": {
"reference": "http://hl7.org/fhir/OrderResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-patient",
"type": "reference",
"documentation": "The patient the reuqest order is related to"
},
{
"name": "fulfillment",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-fulfillment",
"type": "reference",
"documentation": "Details of the outcome of performing the order"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-request",
"type": "reference",
"documentation": "The order that this is a response to"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-code",
"type": "token",
"documentation": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-date",
"type": "date",
"documentation": "When the response was made"
},
{
"name": "who",
"definition": "http://hl7.org/fhir/SearchParameter/orderresponse-who",
"type": "reference",
"documentation": "Who made the response"
}
]
},
{
"type": "Organization",
"profile": {
"reference": "http://hl7.org/fhir/Organization"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/organization-phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "partof",
"definition": "http://hl7.org/fhir/SearchParameter/organization-partof",
"type": "reference",
"documentation": "Search all organizations that are part of the given organization"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/organization-address",
"type": "string",
"documentation": "A (part of the) address of the Organization"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/organization-name",
"type": "string",
"documentation": "A portion of the organization's name"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/organization-active",
"type": "token",
"documentation": "Whether the organization's record is active"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/organization-type",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/organization-identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
}
]
},
{
"type": "Other",
"profile": {
"reference": "http://hl7.org/fhir/Other"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/other-patient",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "created",
"definition": "http://hl7.org/fhir/SearchParameter/other-created",
"type": "date",
"documentation": "When created"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/other-subject",
"type": "reference",
"documentation": "Identifies the"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/other-code",
"type": "token",
"documentation": "Kind of Resource"
}
]
},
{
"type": "Patient",
"profile": {
"reference": "http://hl7.org/fhir/Patient"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "animal-breed",
"definition": "http://hl7.org/fhir/SearchParameter/patient-animal-breed",
"type": "token",
"documentation": "The breed for animal patients"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/patient-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/SearchParameter/patient-link",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "animal-species",
"definition": "http://hl7.org/fhir/SearchParameter/patient-animal-species",
"type": "token",
"documentation": "The species for animal patients"
},
{
"name": "deathdate",
"definition": "http://hl7.org/fhir/SearchParameter/patient-deathdate",
"type": "date",
"documentation": "The date of death has been provided and satisfies this search value"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/patient-organization",
"type": "reference",
"documentation": "The organization at which this person is a patient"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/patient-given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "careprovider",
"definition": "http://hl7.org/fhir/SearchParameter/patient-careprovider",
"type": "reference",
"documentation": "Patient's nominated care provider, could be a care manager, not the organization that manages the record"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/patient-address",
"type": "string",
"documentation": "An address in any kind of address/part of the patient"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/patient-family",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/patient-name",
"type": "string",
"documentation": "A portion of either family or given name of the patient"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/patient-telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/patient-birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/patient-gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "active",
"definition": "http://hl7.org/fhir/SearchParameter/patient-active",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "deceased",
"definition": "http://hl7.org/fhir/SearchParameter/patient-deceased",
"type": "token",
"documentation": "This patient has been marked as deceased, or as a death date entered"
},
{
"name": "language",
"definition": "http://hl7.org/fhir/SearchParameter/patient-language",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/patient-identifier",
"type": "token",
"documentation": "A patient identifier"
}
]
},
{
"type": "PaymentNotice",
"profile": {
"reference": "http://hl7.org/fhir/PaymentNotice"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/paymentnotice-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "PaymentReconciliation",
"profile": {
"reference": "http://hl7.org/fhir/PaymentReconciliation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/paymentreconciliation-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "Person",
"profile": {
"reference": "http://hl7.org/fhir/Person"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/person-organization",
"type": "reference",
"documentation": "The organization at which this person record is being managed"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/person-patient",
"type": "reference",
"documentation": "The Person links to this Patient"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/person-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "practitioner",
"definition": "http://hl7.org/fhir/SearchParameter/person-practitioner",
"type": "reference",
"documentation": "The Person links to this Practitioner"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/person-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "link",
"definition": "http://hl7.org/fhir/SearchParameter/person-link",
"type": "reference",
"documentation": "Any link has this Patient, Person, RelatedPerson or Practitioner reference"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/person-name",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "birthdate",
"definition": "http://hl7.org/fhir/SearchParameter/person-birthdate",
"type": "date",
"documentation": "The person's date of birth"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/person-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/person-gender",
"type": "token",
"documentation": "The gender of the person"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/person-identifier",
"type": "token",
"documentation": "A person Identifier"
},
{
"name": "relatedperson",
"definition": "http://hl7.org/fhir/SearchParameter/person-relatedperson",
"type": "reference",
"documentation": "The Person links to this RelatedPerson"
}
]
},
{
"type": "Practitioner",
"profile": {
"reference": "http://hl7.org/fhir/Practitioner"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "communication",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-communication",
"type": "token",
"documentation": "One of the languages that the practitioner can communicate with"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-location",
"type": "reference",
"documentation": "One of the locations at which this practitioner provides care"
},
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of"
},
{
"name": "given",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-given",
"type": "string",
"documentation": "A portion of the given name"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "family",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-family",
"type": "string",
"documentation": "A portion of the family name"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-name",
"type": "string",
"documentation": "A portion of either family or given name"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-gender",
"type": "token",
"documentation": "Gender of the practitioner"
},
{
"name": "role",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-role",
"type": "token",
"documentation": "The practitioner can perform this role at for the organization"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-identifier",
"type": "token",
"documentation": "A practitioner's Identifier"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/practitioner-specialty",
"type": "token",
"documentation": "The practitioner has this specailty at an organization"
}
]
},
{
"type": "Procedure",
"profile": {
"reference": "http://hl7.org/fhir/Procedure"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-patient",
"type": "reference",
"documentation": "The identity of a patient to list procedures for"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-location",
"type": "reference",
"documentation": "Where the procedure happened"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-performer",
"type": "reference",
"documentation": "The reference to the practitioner"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-date",
"type": "date",
"documentation": "Date/Period the procedure was performed"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/procedure-type",
"type": "token",
"documentation": "Type of procedure"
}
]
},
{
"type": "ProcedureRequest",
"profile": {
"reference": "http://hl7.org/fhir/ProcedureRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "orderer",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-orderer",
"type": "reference",
"documentation": "Ordering Party"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-patient",
"type": "reference",
"documentation": "Search by subject - a patient"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-subject",
"type": "reference",
"documentation": "Search by subject"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-performer",
"type": "reference",
"documentation": "Performer"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/procedurerequest-encounter",
"type": "reference",
"documentation": "Encounter"
}
]
},
{
"type": "ProcessRequest",
"profile": {
"reference": "http://hl7.org/fhir/ProcessRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/processrequest-organization",
"type": "reference",
"documentation": "The organization who generated this request"
},
{
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/processrequest-action",
"type": "token",
"documentation": "The action requested by this resource"
},
{
"name": "provider",
"definition": "http://hl7.org/fhir/SearchParameter/processrequest-provider",
"type": "reference",
"documentation": "The provider who renerated this request"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/processrequest-identifier",
"type": "token",
"documentation": "The business identifier of the ProcessRequest"
}
]
},
{
"type": "ProcessResponse",
"profile": {
"reference": "http://hl7.org/fhir/ProcessResponse"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "organization",
"definition": "http://hl7.org/fhir/SearchParameter/processresponse-organization",
"type": "reference",
"documentation": "The organization who generated this resource"
},
{
"name": "requestprovider",
"definition": "http://hl7.org/fhir/SearchParameter/processresponse-requestprovider",
"type": "reference",
"documentation": "The Provider who is responsible the request transaction"
},
{
"name": "request",
"definition": "http://hl7.org/fhir/SearchParameter/processresponse-request",
"type": "reference",
"documentation": "The reference to the claim"
},
{
"name": "requestorganization",
"definition": "http://hl7.org/fhir/SearchParameter/processresponse-requestorganization",
"type": "reference",
"documentation": "The Organization who is responsible the request transaction"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/processresponse-identifier",
"type": "token",
"documentation": "The business identifier of the Explanation of Benefit"
}
]
},
{
"type": "Provenance",
"profile": {
"reference": "http://hl7.org/fhir/Provenance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "sigtype",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-sigtype",
"type": "token",
"documentation": "Indication of the reason the entity signed the object(s)"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-patient",
"type": "reference",
"documentation": "A patient that the target resource(s) refer to"
},
{
"name": "location",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-location",
"type": "reference",
"documentation": "Where the activity occurred, if relevant"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-start",
"type": "date",
"documentation": "Starting time with inclusive boundary"
},
{
"name": "partytype",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-partytype",
"type": "token",
"documentation": "Agent Type"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-target",
"type": "reference",
"documentation": "Target Reference(s) (usually version specific)"
},
{
"name": "party",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-party",
"type": "reference",
"documentation": "Identity of agent"
},
{
"name": "end",
"definition": "http://hl7.org/fhir/SearchParameter/provenance-end",
"type": "date",
"documentation": "End time with inclusive boundary, if not ongoing"
}
]
},
{
"type": "Questionnaire",
"profile": {
"reference": "http://hl7.org/fhir/Questionnaire"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-title",
"type": "string",
"documentation": "All or part of the name of the questionnaire (title for the root group of the questionnaire)"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-status",
"type": "token",
"documentation": "The status of the questionnaire"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-code",
"type": "token",
"documentation": "A code that corresponds to the questionnaire or one of its groups"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-date",
"type": "date",
"documentation": "When the questionnaire was last changed"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-identifier",
"type": "token",
"documentation": "An identifier for the questionnaire"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-version",
"type": "string",
"documentation": "The business version of the questionnaire"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaire-publisher",
"type": "string",
"documentation": "The author of the questionnaire"
}
]
},
{
"type": "QuestionnaireAnswers",
"profile": {
"reference": "http://hl7.org/fhir/QuestionnaireAnswers"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-author",
"type": "reference",
"documentation": "The author of the questionnaire"
},
{
"name": "questionnaire",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-questionnaire",
"type": "reference",
"documentation": "The questionnaire the answers are provided for"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-patient",
"type": "reference",
"documentation": "The patient that is the subject of the questionnaire"
},
{
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-authored",
"type": "date",
"documentation": "When the questionnaire was authored"
},
{
"name": "source",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-source",
"type": "reference",
"documentation": "The person who answered the questions"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-status",
"type": "token",
"documentation": "The status of the questionnaire answers"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-subject",
"type": "reference",
"documentation": "The subject of the questionnaire"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireanswers-encounter",
"type": "reference",
"documentation": "Encounter during which questionnaire was authored"
}
]
},
{
"type": "ReferralRequest",
"profile": {
"reference": "http://hl7.org/fhir/ReferralRequest"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "requester",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-requester",
"type": "reference",
"documentation": "Requester of referral / transfer of care"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-patient",
"type": "reference",
"documentation": "Who the referral is about"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-status",
"type": "token",
"documentation": "The status of the referral"
},
{
"name": "priority",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-priority",
"type": "token",
"documentation": "The priority assigned to the referral"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-type",
"type": "token",
"documentation": "The type of the referral"
},
{
"name": "specialty",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-specialty",
"type": "token",
"documentation": "The specialty that the referral is for"
},
{
"name": "recipient",
"definition": "http://hl7.org/fhir/SearchParameter/referralrequest-recipient",
"type": "reference",
"documentation": "The person that the referral was sent to"
}
]
},
{
"type": "RelatedPerson",
"profile": {
"reference": "http://hl7.org/fhir/RelatedPerson"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-patient",
"type": "reference",
"documentation": "The patient this person is related to"
},
{
"name": "phonetic",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-phonetic",
"type": "string",
"documentation": "A portion of name using some kind of phonetic matching algorithm"
},
{
"name": "address",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-address",
"type": "string",
"documentation": "An address in any kind of address/part"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-name",
"type": "string",
"documentation": "A portion of name in any name part"
},
{
"name": "telecom",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-telecom",
"type": "token",
"documentation": "The value in any kind of contact"
},
{
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-gender",
"type": "token",
"documentation": "Gender of the person"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/relatedperson-identifier",
"type": "token",
"documentation": "A patient Identifier"
}
]
},
{
"type": "RiskAssessment",
"profile": {
"reference": "http://hl7.org/fhir/RiskAssessment"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-patient",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"name": "condition",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-condition",
"type": "reference",
"documentation": "Condition assessed"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-subject",
"type": "reference",
"documentation": "Who/what does assessment apply to?"
},
{
"name": "performer",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-performer",
"type": "reference",
"documentation": "Who did assessment?"
},
{
"name": "method",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-method",
"type": "token",
"documentation": "Evaluation mechanism"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-date",
"type": "date",
"documentation": "When was assessment made?"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/riskassessment-identifier",
"type": "token",
"documentation": "Unique identifier for the assessment"
}
]
},
{
"type": "Schedule",
"profile": {
"reference": "http://hl7.org/fhir/Schedule"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "actor",
"definition": "http://hl7.org/fhir/SearchParameter/schedule-actor",
"type": "reference",
"documentation": "The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/schedule-date",
"type": "date",
"documentation": "Search for Schedule resources that have a period that contains this date specified"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/schedule-type",
"type": "token",
"documentation": "The type of appointments that can be booked into associated slot(s)"
}
]
},
{
"type": "SearchParameter",
"profile": {
"reference": "http://hl7.org/fhir/SearchParameter"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-description",
"type": "string",
"documentation": "Documentation for search parameter"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-name",
"type": "string",
"documentation": "Name of search parameter"
},
{
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-target",
"type": "token",
"documentation": "Types of resource (if a resource reference)"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-base",
"type": "token",
"documentation": "The resource type this search parameter applies to"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-type",
"type": "token",
"documentation": "number | date | string | token | reference | composite | quantity | uri"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/searchparameter-url",
"type": "uri",
"documentation": "Literal URL used to reference this search parameter"
}
]
},
{
"type": "Slot",
"profile": {
"reference": "http://hl7.org/fhir/Slot"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "schedule",
"definition": "http://hl7.org/fhir/SearchParameter/slot-schedule",
"type": "reference",
"documentation": "The Schedule Resource that we are seeking a slot within"
},
{
"name": "start",
"definition": "http://hl7.org/fhir/SearchParameter/slot-start",
"type": "date",
"documentation": "Appointment date/time."
},
{
"name": "slottype",
"definition": "http://hl7.org/fhir/SearchParameter/slot-slottype",
"type": "token",
"documentation": "The type of appointments that can be booked into the slot"
},
{
"name": "fbtype",
"definition": "http://hl7.org/fhir/SearchParameter/slot-fbtype",
"type": "token",
"documentation": "The free/busy status of the appointment"
}
]
},
{
"type": "Specimen",
"profile": {
"reference": "http://hl7.org/fhir/Specimen"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "collector",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-collector",
"type": "reference",
"documentation": "Who collected the specimen"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-patient",
"type": "reference",
"documentation": "The patient the specimen comes from"
},
{
"name": "site-code",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-site-code",
"type": "token",
"documentation": "The code for the body site from where the specimen originated"
},
{
"name": "container",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-container",
"type": "token",
"documentation": "The kind of specimen container"
},
{
"name": "collected",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-collected",
"type": "date",
"documentation": "The date the specimen was collected"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-subject",
"type": "reference",
"documentation": "The subject of the specimen"
},
{
"name": "containerid",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-containerid",
"type": "token",
"documentation": "The unique identifier associated with the specimen container"
},
{
"name": "site-reference",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-site-reference",
"type": "reference",
"documentation": "BodySite resource for the body site from where the specimen originated"
},
{
"name": "accession",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-accession",
"type": "token",
"documentation": "The accession number associated with the specimen"
},
{
"name": "parent",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-parent",
"type": "reference",
"documentation": "The parent of the specimen"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-type",
"type": "token",
"documentation": "The specimen type"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/specimen-identifier",
"type": "token",
"documentation": "The unique identifier associated with the specimen"
}
]
},
{
"type": "StructureDefinition",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "abstract",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-abstract",
"type": "token",
"documentation": "Whether the structure is abstract"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-status",
"type": "token",
"documentation": "The current status of the profile"
},
{
"name": "experimental",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-experimental",
"type": "token",
"documentation": "If for testing purposes, not real usage"
},
{
"name": "display",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-display",
"type": "string",
"documentation": "Use this name when displaying the value"
},
{
"name": "ext-context",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-ext-context",
"type": "string",
"documentation": "Where the extension can be used in instances"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-code",
"type": "token",
"documentation": "A code for the profile"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-date",
"type": "date",
"documentation": "The profile publication date"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-type",
"type": "token",
"documentation": "type | resource | constraint | extension"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-url",
"type": "uri",
"documentation": "Literal URL used to reference this StructureDefinition"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-version",
"type": "token",
"documentation": "The version identifier of the profile"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-publisher",
"type": "string",
"documentation": "Name of the publisher of the profile"
},
{
"name": "valueset",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-valueset",
"type": "reference",
"documentation": "A vocabulary binding reference"
},
{
"name": "context-type",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-context-type",
"type": "token",
"documentation": "resource | datatype | mapping | extension"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-description",
"type": "string",
"documentation": "Text search in the description of the profile"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-name",
"type": "string",
"documentation": "Name of the profile"
},
{
"name": "base",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-base",
"type": "uri",
"documentation": "Structure that this set of constraints applies to"
},
{
"name": "path",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-path",
"type": "token",
"documentation": "A path that is constrained in the profile"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-context",
"type": "token",
"documentation": "A use context assigned to the structure"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/structuredefinition-identifier",
"type": "token",
"documentation": "The identifier of the profile"
}
]
},
{
"type": "Subscription",
"profile": {
"reference": "http://hl7.org/fhir/Subscription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "criteria",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-criteria",
"type": "string",
"documentation": "Rule for server push criteria"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-status",
"type": "token",
"documentation": "requested | active | error | off"
},
{
"name": "tag",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-tag",
"type": "token",
"documentation": "A tag to add to matching resources"
},
{
"name": "payload",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-payload",
"type": "string",
"documentation": "Mimetype to send, or blank for no payload"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-type",
"type": "token",
"documentation": "rest-hook | websocket | email | sms | message"
},
{
"name": "contact",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-contact",
"type": "token",
"documentation": "Contact details for source (e.g. troubleshooting)"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/subscription-url",
"type": "uri",
"documentation": "Where the channel points to"
}
]
},
{
"type": "Substance",
"profile": {
"reference": "http://hl7.org/fhir/Substance"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "substance",
"definition": "http://hl7.org/fhir/SearchParameter/substance-substance",
"type": "reference",
"documentation": "A component of the substance"
},
{
"name": "quantity",
"definition": "http://hl7.org/fhir/SearchParameter/substance-quantity",
"type": "number",
"documentation": "Amount of substance in the package"
},
{
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/substance-type",
"type": "token",
"documentation": "The type of the substance"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/substance-identifier",
"type": "token",
"documentation": "Identifier of the package/container"
},
{
"name": "expiry",
"definition": "http://hl7.org/fhir/SearchParameter/substance-expiry",
"type": "date",
"documentation": "When no longer valid to use"
}
]
},
{
"type": "Supply",
"profile": {
"reference": "http://hl7.org/fhir/Supply"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/supply-patient",
"type": "reference",
"documentation": "Patient for whom the item is supplied"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/supply-status",
"type": "token",
"documentation": "requested | dispensed | received | failed | cancelled"
},
{
"name": "dispenseid",
"definition": "http://hl7.org/fhir/SearchParameter/supply-dispenseid",
"type": "token",
"documentation": "External identifier"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/supply-identifier",
"type": "token",
"documentation": "Unique identifier"
},
{
"name": "supplier",
"definition": "http://hl7.org/fhir/SearchParameter/supply-supplier",
"type": "reference",
"documentation": "Dispenser"
},
{
"name": "kind",
"definition": "http://hl7.org/fhir/SearchParameter/supply-kind",
"type": "token",
"documentation": "The kind of supply (central, non-stock, etc)"
},
{
"name": "dispensestatus",
"definition": "http://hl7.org/fhir/SearchParameter/supply-dispensestatus",
"type": "token",
"documentation": "in-progress | dispensed | abandoned"
}
]
},
{
"type": "SupportingDocumentation",
"profile": {
"reference": "http://hl7.org/fhir/SupportingDocumentation"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-author",
"type": "reference",
"documentation": "The person who generated this resource"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-patient",
"type": "reference",
"documentation": "The patient to whom the documents refer"
},
{
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-subject",
"type": "reference",
"documentation": "The patient to whom the documents refer"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/supportingdocumentation-identifier",
"type": "token",
"documentation": "The business identifier of the Eligibility"
}
]
},
{
"type": "ValueSet",
"profile": {
"reference": "http://hl7.org/fhir/ValueSet"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "expansion",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-expansion",
"type": "uri",
"documentation": "Uniquely identifies this expansion"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-status",
"type": "token",
"documentation": "The status of the value set"
},
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-code",
"type": "token",
"documentation": "A code defined in the value set"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-date",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-url",
"type": "uri",
"documentation": "The logical url for the value set"
},
{
"name": "reference",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-reference",
"type": "uri",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-version",
"type": "token",
"documentation": "The version identifier of the value set"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-publisher",
"type": "string",
"documentation": "Name of the publisher of the value set"
},
{
"name": "system",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-system",
"type": "uri",
"documentation": "The system for any codes defined by this value set"
},
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-description",
"type": "string",
"documentation": "Text search in the description of the value set"
},
{
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-name",
"type": "string",
"documentation": "The name of the value set"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-context",
"type": "token",
"documentation": "A use context assigned to the value set"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/valueset-identifier",
"type": "token",
"documentation": "The identifier for the value set"
}
]
},
{
"type": "VisionPrescription",
"profile": {
"reference": "http://hl7.org/fhir/VisionPrescription"
},
"interaction": [
{
"code": "read"
},
{
"code": "vread"
},
{
"code": "update"
},
{
"code": "delete"
},
{
"code": "history-instance"
},
{
"code": "validate"
},
{
"code": "history-type"
},
{
"code": "create"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "datewritten",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-datewritten",
"type": "date",
"documentation": "Return prescriptions written on this date"
},
{
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for"
},
{
"name": "prescriber",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-prescriber",
"type": "reference",
"documentation": "Who authorizes the Vision product"
},
{
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-encounter",
"type": "reference",
"documentation": "Return prescriptions with this encounter identity"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/visionprescription-identifier",
"type": "token",
"documentation": "Return prescriptions with this external identity"
}
]
}
],
"interaction": [
{
"code": "transaction"
},
{
"code": "history-system"
},
{
"code": "search-system"
}
]
}
]
}
},
{
"resource": {
"resourceType": "Conformance",
"id": "base2",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/Conformance/base2",
"version": "0.4.0-4902",
"name": "Base FHIR Conformance Statement (Empty)",
"publisher": "FHIR Project Team",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "This is the base conformance statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own conformance statements from. A conformance profile has to contain something, so this contains a read of a Conformance Statement",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"fhirVersion": "0.4.0",
"acceptUnknown": false,
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"documentation": "An empty conformance statement",
"resource": [
{
"type": "Conformance",
"interaction": [
{
"code": "read"
}
]
}
]
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Parameters",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Parameters",
"name": "Parameters",
"publisher": "HL7 FHIR Project",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Base StructureDefinition for Parameters Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Parameters",
"short": "Operation Request or Response",
"definition": "This special resource type is used to represent [operation](operations.html] request and response. It has no other use, and there is no RESTful end=point associated with it.",
"comments": "The parameters that may be used are defined by the OperationDefinition resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Parameters"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Parameters.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Parameters.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Parameters.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Parameters.parameter",
"short": "Operation Parameter",
"definition": "A parameter passed to or received from the operation.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "inv-1",
"name": "Only one value",
"severity": "error",
"human": "A parameter must have a value or a resource, but not both",
"xpath": "exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))"
}
]
},
{
"path": "Parameters.parameter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.parameter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.parameter.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Parameters.parameter.value[x]",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"condition": [
"inv-1"
]
},
{
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
]
},
{
"path": "Parameters.parameter.part",
"short": "Named part of a parameter (e.g. Tuple)",
"definition": "A named part of a parameter. In many implementation context, a set of named parts is known as a \"Tuple\".",
"comments": "Only one level of tuples is allowed.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "inv-2",
"name": "Only one value",
"severity": "error",
"human": "A part must have a value or a resource, but not both",
"xpath": "exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))"
}
]
},
{
"path": "Parameters.parameter.part.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.parameter.part.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.parameter.part.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Parameters.parameter.part.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Parameters.parameter.part.value[x]",
"short": "Value of the part",
"definition": "The value of the parameter.",
"comments": "If there is no value, simply omit the parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"condition": [
"inv-2"
]
},
{
"path": "Parameters.parameter.part.resource",
"short": "If part is a whole resource",
"definition": "If the parameter is a whole resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-2"
]
}
]
},
"differential": {
"element": [
{
"path": "Parameters",
"short": "Operation Request or Response",
"definition": "This special resource type is used to represent [operation](operations.html] request and response. It has no other use, and there is no RESTful end=point associated with it.",
"comments": "The parameters that may be used are defined by the OperationDefinition resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Parameters.parameter",
"short": "Operation Parameter",
"definition": "A parameter passed to or received from the operation.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "inv-1",
"name": "Only one value",
"severity": "error",
"human": "A parameter must have a value or a resource, but not both",
"xpath": "exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))"
}
]
},
{
"path": "Parameters.parameter.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Parameters.parameter.value[x]",
"short": "If parameter is a data type",
"definition": "If the parameter is a data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"condition": [
"inv-1"
]
},
{
"path": "Parameters.parameter.resource",
"short": "If parameter is a whole resource",
"definition": "If the parameter is a whole resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-1"
]
},
{
"path": "Parameters.parameter.part",
"short": "Named part of a parameter (e.g. Tuple)",
"definition": "A named part of a parameter. In many implementation context, a set of named parts is known as a \"Tuple\".",
"comments": "Only one level of tuples is allowed.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "inv-2",
"name": "Only one value",
"severity": "error",
"human": "A part must have a value or a resource, but not both",
"xpath": "exists(f:value) or exists(f:resource) and not(exists(f:value) and exists(f:resource))"
}
]
},
{
"path": "Parameters.parameter.part.name",
"short": "Name from the definition",
"definition": "The name of the parameter (reference to the operation definition).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Parameters.parameter.part.value[x]",
"short": "Value of the part",
"definition": "The value of the parameter.",
"comments": "If there is no value, simply omit the parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "*"
}
],
"condition": [
"inv-2"
]
},
{
"path": "Parameters.parameter.part.resource",
"short": "If part is a whole resource",
"definition": "If the parameter is a whole resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"condition": [
"inv-2"
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Resource-validate",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Resource-validate",
"name": "Validate a resource",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "The validate interaction checks whether the attached content would be acceptable either generally, or as a create, or an update or delete to an existing resource.\n\nThe action the server takes depends on the mode parameter:\n\n* [missing]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules\n* create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not validate any uniqueness constraints)\n* update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate)\n* delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules)\n\nModes update and delete can only be used when the operation is invoked at the resource level. \n\nThe return from this operation is an OperationOutcome",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "validate",
"notes": "This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog, and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to succesfully perform an actual create, update or delete after the validation operation completes.",
"system": false,
"type": [
"Resource"
],
"instance": true,
"parameter": [
{
"name": "resource",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Must be present unles the mode is \"delete\"",
"type": "Resource"
},
{
"name": "mode",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Default is 'no action; (e.g. general validation)",
"type": "string"
},
{
"name": "profile",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate agsinst the nominated profile, it SHALL return an error",
"type": "uri"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below)",
"type": "OperationOutcome"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Resource-meta",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Resource-meta",
"name": "Access a list of profiles, tags, and security labels",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation retrieves a summary of the profiles, tags, and security labels for the given scope. E.g. for each scope:\n\n* system-wide: a list of all profiles, tags and security labels in use by the system\n* resource-type level: A list of all profiles, tags, and security labels for the resource type\n* individual resource level: A list of all profiles, tags, and security labels for the current version of the resource.\n\nAlso, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "meta",
"notes": "At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principle use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't)\n\nAt the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons",
"system": true,
"type": [
"Resource"
],
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The meta returned by the operation",
"type": "Meta"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Resource-meta-add",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Resource-meta-add",
"name": "Add profiles, tags, and security labels to a resource",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation takes a meta, and either adds the profiles, tags, and security labels found in it to the nominated resource. \n\nThis operation can also be used on historical entries - to update them without creating a different historical version",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "meta-add",
"notes": "This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources",
"system": false,
"instance": true,
"parameter": [
{
"name": "meta",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created.\n\nThe identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles matching is based on the full URL",
"type": "Meta"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Resulting meta for the resource",
"type": "Meta"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Resource-meta-delete",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Resource-meta-delete",
"name": "Delete profiles, tags, and security labels for a resource",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation takes a meta, and either deletes the profiles, tags, and security labels found in it from the nominated resource. \n\nThis operation can also be used on historical entries",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "meta-delete",
"notes": "This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources",
"system": false,
"instance": true,
"parameter": [
{
"name": "meta",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Profiles, tags, and security labels to add delete from the existing resource. It is not an error if these tags, profiles, and labels do not exist.\n\nThe identity of a tag or security label is the system+code. When matching existing tags during deletion, version and display are ignored. For profiles matching is based on the full URL",
"type": "Meta"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Resulting meta for the resource",
"type": "Meta"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Resource",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Resource",
"name": "Resource",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Resource Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/",
"snapshot": {
"element": [
{
"path": "Resource",
"short": "Base Resource",
"definition": "Base Resource for everything.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
}
]
},
{
"path": "Resource.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Resource.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Resource.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Resource.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
}
]
},
"differential": {
"element": [
{
"path": "Resource",
"short": "Base Resource",
"definition": "Base Resource for everything.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
}
]
},
{
"path": "Resource.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Resource.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Resource.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Resource.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DomainResource",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"name": "DomainResource",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DomainResource Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DomainResource",
"short": "A resource with narrative, extensions, and contained resources",
"definition": "A resource that includes narrative, extensions, and contained resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "dom-4",
"name": "No versionId and lastUpdated in contained resources",
"severity": "error",
"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))"
},
{
"key": "dom-3",
"name": "No contained resources that are not referenced from elsewhere",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
},
{
"key": "dom-2",
"name": "No nested contained resources",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL not contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"name": "No narrative in contained resources",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL not contain any narrative",
"xpath": "not(parent::f:contained and f:text)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
}
]
},
{
"path": "DomainResource.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DomainResource.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DomainResource.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DomainResource.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DomainResource.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DomainResource.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DomainResource.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DomainResource.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DomainResource",
"short": "A resource with narrative, extensions, and contained resources",
"definition": "A resource that includes narrative, extensions, and contained resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "dom-4",
"name": "No versionId and lastUpdated in contained resources",
"severity": "error",
"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))"
},
{
"key": "dom-3",
"name": "No contained resources that are not referenced from elsewhere",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
},
{
"key": "dom-2",
"name": "No nested contained resources",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL not contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"name": "No narrative in contained resources",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL not contain any narrative",
"xpath": "not(parent::f:contained and f:text)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
}
]
},
{
"path": "DomainResource.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DomainResource.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DomainResource.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DomainResource.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Alert",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Alert",
"name": "Alert",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Alert Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Alert",
"short": "Key information to flag to healthcare providers",
"definition": "Prospective warnings of potential issues when providing care to the patient.",
"alias": [
"Barriers to Care"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Alert"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=ISSUE, moodCode=EVN]"
}
]
},
{
"path": "Alert.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Alert.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Alert.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Alert.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Alert.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Alert.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Alert.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Alert.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Alert.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the alert for external use (outside the FHIR environment).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Alert.category",
"short": "Clinical, administrative, etc.",
"definition": "Allows an alert to be divided into different categories like clinical, administrative etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Alert.status",
"short": "active | inactive | entered-in-error",
"definition": "Supports basic workflow.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "AlertStatus",
"strength": "required",
"description": "Indicates whether this alert is active and needs to be displayed to a user, or whether it is no longer needed or entered in error",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/alert-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
}
]
},
{
"path": "Alert.patient",
"short": "Who is alert about?",
"definition": "The person who this alert concerns.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Alert.author",
"short": "Alert creator",
"definition": "The person or device that created the alert.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Alert.note",
"short": "Partially deaf, Requires easy open caps, No permanent address, etc.",
"definition": "The coded value or textual component of the alert to display to the user.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Alert",
"short": "Key information to flag to healthcare providers",
"definition": "Prospective warnings of potential issues when providing care to the patient.",
"alias": [
"Barriers to Care"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=ISSUE, moodCode=EVN]"
}
]
},
{
"path": "Alert.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the alert for external use (outside the FHIR environment).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Alert.category",
"short": "Clinical, administrative, etc.",
"definition": "Allows an alert to be divided into different categories like clinical, administrative etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Alert.status",
"short": "active | inactive | entered-in-error",
"definition": "Supports basic workflow.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "AlertStatus",
"strength": "required",
"description": "Indicates whether this alert is active and needs to be displayed to a user, or whether it is no longer needed or entered in error",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/alert-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
}
]
},
{
"path": "Alert.patient",
"short": "Who is alert about?",
"definition": "The person who this alert concerns.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Alert.author",
"short": "Alert creator",
"definition": "The person or device that created the alert.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Alert.note",
"short": "Partially deaf, Requires easy open caps, No permanent address, etc.",
"definition": "The coded value or textual component of the alert to display to the user.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "AllergyIntolerance",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance",
"name": "AllergyIntolerance",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for AllergyIntolerance Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "AllergyIntolerance",
"short": "Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comments": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"requirements": "To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.",
"alias": [
"Allergy",
"Intolerance",
"Adverse Reaction"
],
"min": 1,
"max": "1",
"type": [
{
"code": "AllergyIntolerance"
}
]
},
{
"path": "AllergyIntolerance.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "AllergyIntolerance.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "AllergyIntolerance.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "AllergyIntolerance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "AllergyIntolerance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "AllergyIntolerance.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AllergyIntolerance.recordedDate",
"short": "When recorded",
"definition": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "AllergyIntolerance.recorder",
"short": "Who recorded the sensitivity",
"definition": "Indicates who has responsibility for the record.",
"alias": [
"Author"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "AllergyIntolerance.patient",
"short": "Who the sensitivity is for",
"definition": "The patient who has the allergy or intolerance.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "AllergyIntolerance.reporter",
"short": "Source of the information about the allergy",
"definition": "The source of the information about the allergy that is recorded.",
"comments": "The recorder takes repsonsibility for the content, but can reference the source from where they got it.",
"alias": [
"Source",
"Informant"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.substance",
"short": "Substance, (or class) considered to be responsible for risk",
"definition": "Identification of a substance, or a class of substances, that is considered to be responsible for the Adverse reaction risk.",
"comments": "It is strongly recommended that Substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, Snomed CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available.",
"alias": [
"Agent"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
}
},
{
"path": "AllergyIntolerance.status",
"short": "unconfirmed | confirmed | resolved | refuted | entered-in-error",
"definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.",
"comments": "Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction.\rIn particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List.\rSome implementations may choose to make this field mandatory.",
"alias": [
"State"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceStatus",
"strength": "required",
"description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-status"
}
}
},
{
"path": "AllergyIntolerance.criticality",
"short": "low | high | unassessible - Estimated potential clinical harm",
"definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.",
"comments": "The default criticality value for any propensity to an Adverse Reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).",
"alias": [
"Severity",
"Seriousness",
"Contra-indication",
"Risk"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCriticality",
"strength": "required",
"description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-criticality"
}
}
},
{
"path": "AllergyIntolerance.type",
"short": "immune | non-immune - Underlying mechanism (if known)",
"definition": "Identification of the underlying physiological mechanism for the Reaction Risk.",
"comments": "Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune and non-immune and still carry life threatening risk. \r\rIt is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. This data element is included nevertheless because many legacy systems have captured this attribute.\r\rImmunological testing may provide supporting evidence for the basis and causative substance , but no tests are 100% sensitive or specific for a sensitivity.",
"alias": [
"Category",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceType",
"strength": "required",
"description": "Identification of the underlying physiological mechanism for a Reaction Risk",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-type"
}
}
},
{
"path": "AllergyIntolerance.category",
"short": "food | medication | environment - Category of Substance",
"definition": "Category of the identified Substance.",
"comments": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.",
"alias": [
"Category",
"Type",
"Reaction Type",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCategory",
"strength": "required",
"description": "Category of an identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-category"
}
}
},
{
"path": "AllergyIntolerance.lastOccurence",
"short": "Date(/time) of last known occurence of a reaction",
"definition": "Represents the date and/or time of the last known occurence of a reaction event.",
"comments": "This date may be replicated by one of the Onset of Reaction dates.\rWhere a textual representation of the date of last occurence is required e.g 'In Childhood, '10 years ago' the Comment element should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.comment",
"short": "Additional text not captured in other fields",
"definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comments": "For example: including reason for flagging a Seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "AllergyIntolerance.event",
"short": "Adverse Reaction Events linked to exposure to substance",
"definition": "Details about each Adverse Reaction Event linked to exposure to the identified Substance.",
"min": 0,
"max": "*"
},
{
"path": "AllergyIntolerance.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AllergyIntolerance.event.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AllergyIntolerance.event.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AllergyIntolerance.event.substance",
"short": "Specific substance considered to be responsible for event",
"definition": "Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.",
"comments": "Coding of the Specific Substance with a terminology capable of triggering decision support should be used wherever possible. \rThe Substance field allows for the use of a specific substance or a group or class of substances, for example \"Penicillins\". The specific Substance field could be used for Amoxycillin.\rDuplication is acceptable when a specific substance has been recorded in the 'Substance' field.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
}
},
{
"path": "AllergyIntolerance.event.certainty",
"short": "unlikely | likely | confirmed - clinical certainty about the specific substance",
"definition": "Statement about the degree of clinical certainty that the Specific Substance was the cause of the Manifestation in this reaction event.",
"alias": [
"Cause"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCertainty",
"strength": "required",
"description": "Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reaction-event-certainty"
}
}
},
{
"path": "AllergyIntolerance.event.manifestation",
"short": "Clinical symptoms/signs associated with the Event",
"definition": "Clinical symptoms and/or signs that are observed or associated with the Adverse Reaction Event.",
"comments": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that Manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines.\r\rTerminologies commonly used include, but are not limited to, SNOMED-CT or ICD10.",
"alias": [
"Symptoms",
"Signs"
],
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "Manifestation",
"strength": "example",
"description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/manifestation-codes"
}
}
},
{
"path": "AllergyIntolerance.event.description",
"short": "Description of the event as a whole",
"definition": "Text description about the Reaction as a whole, including details of the manifestation if required.",
"alias": [
"Narrative",
"Text"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "AllergyIntolerance.event.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.event.duration",
"short": "How long Manifestations persisted",
"definition": "The amount of time that the Adverse Reaction persisted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
]
},
{
"path": "AllergyIntolerance.event.severity",
"short": "mild | moderate | severe (of event as a whole)",
"definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comments": "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied.\rObjective scales can be included in this model as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceSeverity",
"strength": "required",
"description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reaction-event-severity"
}
}
},
{
"path": "AllergyIntolerance.event.exposureRoute",
"short": "How the subject was exposed to the substance",
"definition": "Identification of the route by which the subject was exposed to the substance.",
"comments": "Coding of the Route of Exposure with a terminology should be used wherever possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
}
},
{
"path": "AllergyIntolerance.event.comment",
"short": "Text about event not captured in other fields",
"definition": "Additional text about the Adverse Reaction event not captured in other fields.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"path": "AllergyIntolerance",
"short": "Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance)",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.",
"comments": "Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.",
"requirements": "To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.",
"alias": [
"Allergy",
"Intolerance",
"Adverse Reaction"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "AllergyIntolerance.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this allergy/intolerance concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AllergyIntolerance.recordedDate",
"short": "When recorded",
"definition": "Date when the sensitivity was recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "AllergyIntolerance.recorder",
"short": "Who recorded the sensitivity",
"definition": "Indicates who has responsibility for the record.",
"alias": [
"Author"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "AllergyIntolerance.patient",
"short": "Who the sensitivity is for",
"definition": "The patient who has the allergy or intolerance.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "AllergyIntolerance.reporter",
"short": "Source of the information about the allergy",
"definition": "The source of the information about the allergy that is recorded.",
"comments": "The recorder takes repsonsibility for the content, but can reference the source from where they got it.",
"alias": [
"Source",
"Informant"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.substance",
"short": "Substance, (or class) considered to be responsible for risk",
"definition": "Identification of a substance, or a class of substances, that is considered to be responsible for the Adverse reaction risk.",
"comments": "It is strongly recommended that Substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, Snomed CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available.",
"alias": [
"Agent"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
}
},
{
"path": "AllergyIntolerance.status",
"short": "unconfirmed | confirmed | resolved | refuted | entered-in-error",
"definition": "Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.",
"comments": "Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction.\rIn particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List.\rSome implementations may choose to make this field mandatory.",
"alias": [
"State"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceStatus",
"strength": "required",
"description": "Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-status"
}
}
},
{
"path": "AllergyIntolerance.criticality",
"short": "low | high | unassessible - Estimated potential clinical harm",
"definition": "Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.",
"comments": "The default criticality value for any propensity to an Adverse Reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).",
"alias": [
"Severity",
"Seriousness",
"Contra-indication",
"Risk"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCriticality",
"strength": "required",
"description": "Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-criticality"
}
}
},
{
"path": "AllergyIntolerance.type",
"short": "immune | non-immune - Underlying mechanism (if known)",
"definition": "Identification of the underlying physiological mechanism for the Reaction Risk.",
"comments": "Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune and non-immune and still carry life threatening risk. \r\rIt is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. This data element is included nevertheless because many legacy systems have captured this attribute.\r\rImmunological testing may provide supporting evidence for the basis and causative substance , but no tests are 100% sensitive or specific for a sensitivity.",
"alias": [
"Category",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceType",
"strength": "required",
"description": "Identification of the underlying physiological mechanism for a Reaction Risk",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-type"
}
}
},
{
"path": "AllergyIntolerance.category",
"short": "food | medication | environment - Category of Substance",
"definition": "Category of the identified Substance.",
"comments": "This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.",
"alias": [
"Category",
"Type",
"Reaction Type",
"Class"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCategory",
"strength": "required",
"description": "Category of an identified Substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/allergy-intolerance-category"
}
}
},
{
"path": "AllergyIntolerance.lastOccurence",
"short": "Date(/time) of last known occurence of a reaction",
"definition": "Represents the date and/or time of the last known occurence of a reaction event.",
"comments": "This date may be replicated by one of the Onset of Reaction dates.\rWhere a textual representation of the date of last occurence is required e.g 'In Childhood, '10 years ago' the Comment element should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.comment",
"short": "Additional text not captured in other fields",
"definition": "Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.",
"comments": "For example: including reason for flagging a Seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "AllergyIntolerance.event",
"short": "Adverse Reaction Events linked to exposure to substance",
"definition": "Details about each Adverse Reaction Event linked to exposure to the identified Substance.",
"min": 0,
"max": "*"
},
{
"path": "AllergyIntolerance.event.substance",
"short": "Specific substance considered to be responsible for event",
"definition": "Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.",
"comments": "Coding of the Specific Substance with a terminology capable of triggering decision support should be used wherever possible. \rThe Substance field allows for the use of a specific substance or a group or class of substances, for example \"Penicillins\". The specific Substance field could be used for Amoxycillin.\rDuplication is acceptable when a specific substance has been recorded in the 'Substance' field.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
}
},
{
"path": "AllergyIntolerance.event.certainty",
"short": "unlikely | likely | confirmed - clinical certainty about the specific substance",
"definition": "Statement about the degree of clinical certainty that the Specific Substance was the cause of the Manifestation in this reaction event.",
"alias": [
"Cause"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceCertainty",
"strength": "required",
"description": "Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reaction-event-certainty"
}
}
},
{
"path": "AllergyIntolerance.event.manifestation",
"short": "Clinical symptoms/signs associated with the Event",
"definition": "Clinical symptoms and/or signs that are observed or associated with the Adverse Reaction Event.",
"comments": "Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that Manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines.\r\rTerminologies commonly used include, but are not limited to, SNOMED-CT or ICD10.",
"alias": [
"Symptoms",
"Signs"
],
"min": 1,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "Manifestation",
"strength": "example",
"description": "Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/manifestation-codes"
}
}
},
{
"path": "AllergyIntolerance.event.description",
"short": "Description of the event as a whole",
"definition": "Text description about the Reaction as a whole, including details of the manifestation if required.",
"alias": [
"Narrative",
"Text"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "AllergyIntolerance.event.onset",
"short": "Date(/time) when manifestations showed",
"definition": "Record of the date and/or time of the onset of the Reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "AllergyIntolerance.event.duration",
"short": "How long Manifestations persisted",
"definition": "The amount of time that the Adverse Reaction persisted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
]
},
{
"path": "AllergyIntolerance.event.severity",
"short": "mild | moderate | severe (of event as a whole)",
"definition": "Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.",
"comments": "It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied.\rObjective scales can be included in this model as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AllergyIntoleranceSeverity",
"strength": "required",
"description": "Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reaction-event-severity"
}
}
},
{
"path": "AllergyIntolerance.event.exposureRoute",
"short": "How the subject was exposed to the substance",
"definition": "Identification of the route by which the subject was exposed to the substance.",
"comments": "Coding of the Route of Exposure with a terminology should be used wherever possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
}
},
{
"path": "AllergyIntolerance.event.comment",
"short": "Text about event not captured in other fields",
"definition": "Additional text about the Adverse Reaction event not captured in other fields.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Appointment",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Appointment",
"name": "Appointment",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Appointment Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Appointment",
"short": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"definition": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"min": 1,
"max": "1",
"type": [
{
"code": "Appointment"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "rim",
"map": "Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"
}
]
},
{
"path": "Appointment.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Appointment.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Appointment.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Appointment.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Appointment.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Appointment.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Appointment.status",
"short": "pending | booked | arrived | fulfilled | cancelled | noshow",
"definition": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.",
"comments": "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slot's that were marked as BUSY can be re-set to FREE.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "AppointmentStatus",
"strength": "required",
"description": "The free/busy status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/appointmentstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Appointment.type",
"short": "The type of appointment that is being booked",
"definition": "The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Appointment.reason",
"short": "The reason that this appointment is being scheduled, this is more clinical than administrative",
"definition": "The reason that this appointment is being scheduled, this is more clinical than administrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ApptReason",
"strength": "required",
"description": "The Reason for the appointment to take place",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIS-3, ARQ-7"
},
{
"identity": "rim",
"map": "(encounter appointment).reason"
}
]
},
{
"path": "Appointment.priority",
"short": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)",
"definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "ical",
"map": "PRIORITY"
},
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "Appointment.description",
"short": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field",
"definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "DESCRIPTION"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Appointment.start",
"short": "Date/Time that the appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
}
]
},
{
"path": "Appointment.end",
"short": "Date/Time that the appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.2, SCH-11.5 / TQ1-8"
},
{
"identity": "rim",
"map": ".effectiveTime.high"
}
]
},
{
"path": "Appointment.slot",
"short": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot",
"definition": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Slot"
}
],
"mapping": [
{
"identity": "rim",
"map": "Schedule-Slot (classCode=ACT, moodCode = SLOT)"
}
]
},
{
"path": "Appointment.comment",
"short": "Additional comments about the appointment",
"definition": "Additional comments about the appointment.",
"comments": "Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient should proceed immediately to infusion room upon arrival”.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
},
{
"identity": "v2",
"map": "NTE-3"
}
]
},
{
"path": "Appointment.order",
"short": "An Order that lead to the creation of this appointment",
"definition": "An Order that lead to the creation of this appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Order"
}
],
"mapping": [
{
"identity": "v2",
"map": "ARQ-24, SCH-26"
},
{
"identity": "rim",
"map": ".referencedOrder"
}
]
},
{
"path": "Appointment.participant",
"short": "List of participants involved in the appointment",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE component to be created"
},
{
"identity": "v2",
"map": "PID, AIP, AIG, AIL"
}
]
},
{
"path": "Appointment.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Appointment.participant.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Appointment.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Appointment.participant.type",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
},
{
"identity": "v2",
"map": "AIP-4, AIG-4"
}
]
},
{
"path": "Appointment.participant.actor",
"short": "A Person, Location/HealthcareService or Device that is participating in the appointment",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\""
},
{
"identity": "v2",
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity": "rim",
"map": "performer | reusableDevice | subject | location"
}
]
},
{
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantRequired",
"strength": "required",
"description": "Is the Participant required to attend the appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participantrequired"
}
},
"mapping": [
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
},
{
"identity": "rim",
"map": "performer.performIndicator"
}
]
},
{
"path": "Appointment.participant.status",
"short": "accepted | declined | tentative | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ParticipationStatus",
"strength": "required",
"description": "The Participation status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participationstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
},
{
"identity": "v2",
"map": "AIP-12, AIG-14"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Appointment",
"short": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)",
"definition": "A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
},
{
"identity": "rim",
"map": "Act (ActMood = ActMoodAppointment or ActMoodAppointmentRequest)"
}
]
},
{
"path": "Appointment.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "v2",
"map": "SCH-1, SCH-2, ARQ-1, ARQ-2"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Appointment.status",
"short": "pending | booked | arrived | fulfilled | cancelled | noshow",
"definition": "The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.",
"comments": "If the Appointment's status is \"cancelled\" then all participants are expected to have their calendars released for the appointment period, and as such any Slot's that were marked as BUSY can be re-set to FREE.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "AppointmentStatus",
"strength": "required",
"description": "The free/busy status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/appointmentstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "SCH-25"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Appointment.type",
"short": "The type of appointment that is being booked",
"definition": "The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Appointment.reason",
"short": "The reason that this appointment is being scheduled, this is more clinical than administrative",
"definition": "The reason that this appointment is being scheduled, this is more clinical than administrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ApptReason",
"strength": "required",
"description": "The Reason for the appointment to take place",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "AIS-3, ARQ-7"
},
{
"identity": "rim",
"map": "(encounter appointment).reason"
}
]
},
{
"path": "Appointment.priority",
"short": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)",
"definition": "The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "ical",
"map": "PRIORITY"
},
{
"identity": "v2",
"map": "ARQ-12, SCH-11.6 / TQ1-9"
},
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "Appointment.description",
"short": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field",
"definition": "The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "DESCRIPTION"
},
{
"identity": "v2",
"map": "NTE-3"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Appointment.start",
"short": "Date/Time that the appointment is to take place",
"definition": "Date/Time that the appointment is to take place.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.1, SCH-11.4 / TQ1-7"
},
{
"identity": "rim",
"map": ".effectiveTime.low"
}
]
},
{
"path": "Appointment.end",
"short": "Date/Time that the appointment is to conclude",
"definition": "Date/Time that the appointment is to conclude.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ARQ-11.2, SCH-11.5 / TQ1-8"
},
{
"identity": "rim",
"map": ".effectiveTime.high"
}
]
},
{
"path": "Appointment.slot",
"short": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot",
"definition": "The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Slot"
}
],
"mapping": [
{
"identity": "rim",
"map": "Schedule-Slot (classCode=ACT, moodCode = SLOT)"
}
]
},
{
"path": "Appointment.comment",
"short": "Additional comments about the appointment",
"definition": "Additional comments about the appointment.",
"comments": "Additional text to aid in facilitating the appointment. For instance, a comment might be, “patient should proceed immediately to infusion room upon arrival”.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
},
{
"identity": "v2",
"map": "NTE-3"
}
]
},
{
"path": "Appointment.order",
"short": "An Order that lead to the creation of this appointment",
"definition": "An Order that lead to the creation of this appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Order"
}
],
"mapping": [
{
"identity": "v2",
"map": "ARQ-24, SCH-26"
},
{
"identity": "rim",
"map": ".referencedOrder"
}
]
},
{
"path": "Appointment.participant",
"short": "List of participants involved in the appointment",
"definition": "List of participants involved in the appointment.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE component to be created"
},
{
"identity": "v2",
"map": "PID, AIP, AIG, AIL"
}
]
},
{
"path": "Appointment.participant.type",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
},
{
"identity": "v2",
"map": "AIP-4, AIG-4"
}
]
},
{
"path": "Appointment.participant.actor",
"short": "A Person, Location/HealthcareService or Device that is participating in the appointment",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not \"information-only\""
},
{
"identity": "v2",
"map": "PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3"
},
{
"identity": "rim",
"map": "performer | reusableDevice | subject | location"
}
]
},
{
"path": "Appointment.participant.required",
"short": "required | optional | information-only",
"definition": "Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantRequired",
"strength": "required",
"description": "Is the Participant required to attend the appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participantrequired"
}
},
"mapping": [
{
"identity": "ical",
"map": "ROLE=REQ-PARTICIPANT (roleparam)"
},
{
"identity": "rim",
"map": "performer.performIndicator"
}
]
},
{
"path": "Appointment.participant.status",
"short": "accepted | declined | tentative | needs-action",
"definition": "Participation status of the Patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ParticipationStatus",
"strength": "required",
"description": "The Participation status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participationstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
},
{
"identity": "v2",
"map": "AIP-12, AIG-14"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "AppointmentResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/AppointmentResponse",
"name": "AppointmentResponse",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for AppointmentResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "AppointmentResponse",
"short": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min": 1,
"max": "1",
"type": [
{
"code": "AppointmentResponse"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"path": "AppointmentResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "AppointmentResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "AppointmentResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "AppointmentResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "AppointmentResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "AppointmentResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AppointmentResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AppointmentResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment response concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AppointmentResponse.appointment",
"short": "Parent appointment that this response is replying to",
"definition": "Parent appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true
},
{
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "AppointmentResponse.actor",
"short": "A Person, Location/HealthcareService or Device that is participating in the appointment",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
},
{
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action",
"definition": "Participation status of the Participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ParticipantStatus",
"strength": "required",
"description": "The Participation status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participantstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"path": "AppointmentResponse.comment",
"short": "Additional comments about the appointment",
"definition": "This comment is particularly important when the responder is declining, tentative or requesting another time to indicate the reasons why.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
}
]
},
{
"path": "AppointmentResponse.start",
"short": "Date/Time that the appointment is to take place, or requested new start time",
"definition": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.end",
"short": "Date/Time that the appointment is to conclude, or requested new end time",
"definition": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
}
]
},
"differential": {
"element": [
{
"path": "AppointmentResponse",
"short": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection",
"definition": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "ical",
"map": "VEVENT"
}
]
},
{
"path": "AppointmentResponse.identifier",
"short": "External Ids for this item",
"definition": "This records identifiers associated with this appointment response concern that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AppointmentResponse.appointment",
"short": "Parent appointment that this response is replying to",
"definition": "Parent appointment that this response is replying to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true
},
{
"path": "AppointmentResponse.participantType",
"short": "Role of participant in the appointment",
"definition": "Role of participant in the appointment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "AppointmentResponse.actor",
"short": "A Person, Location/HealthcareService or Device that is participating in the appointment",
"definition": "A Person, Location/HealthcareService or Device that is participating in the appointment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource)"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
},
{
"path": "AppointmentResponse.participantStatus",
"short": "accepted | declined | tentative | in-process | completed | needs-action",
"definition": "Participation status of the Participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ParticipantStatus",
"strength": "required",
"description": "The Participation status of an appointment",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/participantstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE;CN=\"Brian Postlethwaite\";RSVP=TRUE:mailto:BPostlethwaite@data.com (rsvpparam | partstatparam)"
}
]
},
{
"path": "AppointmentResponse.comment",
"short": "Additional comments about the appointment",
"definition": "This comment is particularly important when the responder is declining, tentative or requesting another time to indicate the reasons why.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT"
}
]
},
{
"path": "AppointmentResponse.start",
"short": "Date/Time that the appointment is to take place, or requested new start time",
"definition": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the start time.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "AppointmentResponse.end",
"short": "Date/Time that the appointment is to conclude, or requested new end time",
"definition": "This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "AuditEvent",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"name": "AuditEvent",
"publisher": "HL7 FHIR Project (Security)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/secure/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for AuditEvent Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "AuditEvent",
"short": "Event record kept for security purposes",
"definition": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comments": "Based on ATNA (RFC 3881).",
"min": 1,
"max": "1",
"type": [
{
"code": "AuditEvent"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Message"
},
{
"identity": "rim",
"map": "ControlAct[moodCode=EVN]"
}
]
},
{
"path": "AuditEvent.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "AuditEvent.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "AuditEvent.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "AuditEvent.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "AuditEvent.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "AuditEvent.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.event",
"short": "What was done",
"definition": "Identifies the name, action type, time, and disposition of the audited event.",
"requirements": "The event must be identified.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "dicom",
"map": "EventIdentification"
},
{
"identity": "rim",
"map": "N/A (no nesting in v3)"
}
]
},
{
"path": "AuditEvent.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.event.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.event.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.event.type",
"short": "Type/identifier of event",
"definition": "Identifier for a family of the event.",
"comments": "e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventType",
"strength": "required",
"description": "Type of event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventId"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.subtype",
"short": "More specific type/id for the event",
"definition": "Identifier for the category of event.",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventSubType",
"strength": "required",
"description": "Sub-type of event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-sub-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventTypeCode"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.action",
"short": "Type of action performed during the event",
"definition": "Indicator for type of action performed during the event that generated the audit.",
"requirements": "This broadly indicates what kind of action was done on the Participant Object.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventAction",
"strength": "required",
"description": "Indicator for type of action performed during the event that generated the audit.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-action"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventActionCode"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.dateTime",
"short": "Time when the event occurred on source",
"definition": "The time when the event occurred on the source.",
"comments": "In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic.",
"requirements": "This ties an event to a specific date and time. Security audits typically require a consistent time base, e.g., UTC, to eliminate time-zone issues arising from geographical distribution.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@EventDateTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "AuditEvent.event.outcome",
"short": "Whether the event succeeded or failed",
"definition": "Indicates whether the event succeeded or failed.",
"comments": "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventOutcome",
"strength": "required",
"description": "Indicates whether the event succeeded or failed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-outcome"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventOutcomeIndicator"
},
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"path": "AuditEvent.event.outcomeDesc",
"short": "Description of the event outcome",
"definition": "A free text description of the outcome of the event.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@EventOutcomeDescription"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
}
]
},
{
"path": "AuditEvent.participant",
"short": "A person, a hardware device or software process",
"definition": "A person, a hardware device or software process.",
"comments": "There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event.",
"requirements": "The event has one or more active participants.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "sev-3",
"name": "Participant Identification",
"severity": "error",
"human": "Either a userId or a reference, but not both",
"xpath": "exists(f:userId) != exists(f:reference)"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ActiveParticipant"
},
{
"identity": "rim",
"map": ".participation"
}
]
},
{
"path": "AuditEvent.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.participant.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.participant.role",
"short": "User roles (e.g. local RBAC codes)",
"definition": "Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context.",
"requirements": "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DICOMRoleId",
"strength": "required",
"description": "Role(s) the user plays (from RBAC)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dicm-402-roleid"
}
},
"mapping": [
{
"identity": "dicom",
"map": "RoleIdCode"
},
{
"identity": "rim",
"map": ".typeCode and/or .functionCode"
}
]
},
{
"path": "AuditEvent.participant.reference",
"short": "Direct reference to resource",
"definition": "Direct reference to a resource that identifies the participant.",
"requirements": "This field ties an audit event to a specific resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"condition": [
"sev-3"
],
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "AuditEvent.participant.userId",
"short": "Unique identifier for the user",
"definition": "Unique identifier for the user actively participating in the event.",
"comments": "a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"requirements": "This field ties an audit event to a specific user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-3"
],
"mapping": [
{
"identity": "dicom",
"map": "@UserId"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AuditEvent.participant.altId",
"short": "Alternative User id e.g. authentication",
"definition": "Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available.",
"requirements": "In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AlternativeUserId"
},
{
"identity": "rim",
"map": ".id (distinguish id type by root)"
}
]
},
{
"path": "AuditEvent.participant.name",
"short": "Human-meaningful name for the user",
"definition": "Human-meaningful name for the user.",
"requirements": "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@UserName"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "AuditEvent.participant.requestor",
"short": "Whether user is initiator",
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comments": "There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator.",
"requirements": "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@UserIsRequestor"
},
{
"identity": "rim",
"map": "If participation.typeCode was author, then true"
}
]
},
{
"path": "AuditEvent.participant.location",
"short": "Where",
"definition": "Where the event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "AuditEvent.participant.policy",
"short": "Policy that authorized event",
"definition": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "AuditEvent.participant.media",
"short": "Type of media",
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements": "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "MediaType"
},
{
"identity": "rim",
"map": ".player.description.mediaType"
}
]
},
{
"path": "AuditEvent.participant.network",
"short": "Logical network location for application activity",
"definition": "Logical network location for application activity, if the activity has a network location.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player.description.reference"
}
]
},
{
"path": "AuditEvent.participant.network.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.participant.network.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.participant.network.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.participant.network.identifier",
"short": "Identifier for the network access point of the user device",
"definition": "An identifier for the network access point of the user device for the audit event.",
"comments": "This could be a device id, IP address or some other identifier associated with a device.",
"requirements": "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@NetworkAccessPointID"
},
{
"identity": "rim",
"map": "pre-coordinated into URL"
}
]
},
{
"path": "AuditEvent.participant.network.type",
"short": "The type of network access point",
"definition": "An identifier for the type of network access point that originated the audit event.",
"requirements": "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventParticipantNetworkType",
"strength": "required",
"description": "The type of network access point that originated the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/network-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@NetworkAccessPointTypeCode"
},
{
"identity": "rim",
"map": "pre-coordinated into URL"
}
]
},
{
"path": "AuditEvent.source",
"short": "Application systems and processes",
"definition": "Application systems and processes.",
"comments": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants, e.g., low-level network transports, need not be identified.",
"requirements": "The event is reported by one source.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "dicom",
"map": "AuditSourceIdentification"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
}
]
},
{
"path": "AuditEvent.source.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.source.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.source.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.source.site",
"short": "Logical source location within the enterprise",
"definition": "Logical source location within the healthcare enterprise network.",
"comments": "a hospital or other provider location within a multi-entity provider group.",
"requirements": "This value differentiates among the sites in a multi-site enterprise health information system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AuditEnterpriseSiteId"
},
{
"identity": "rim",
"map": ".scopedRole[classCode=LOCE].player.desc"
}
]
},
{
"path": "AuditEvent.source.identifier",
"short": "The id of source where event originated",
"definition": "Identifier of the source where the event originated.",
"requirements": "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event occurred.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AuditSourceId"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AuditEvent.source.type",
"short": "The type of source where event originated",
"definition": "Code specifying the type of source where event originated.",
"requirements": "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AuditEventSourceType",
"strength": "required",
"description": "Code specifying the type of source where event originated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-source-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "AuditSourceTypeCode"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "AuditEvent.object",
"short": "Specific instances of data or objects that have been accessed",
"definition": "Specific instances of data or objects that have been accessed.",
"comments": "required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values.",
"requirements": "The event may have other objects involved.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "sev-2",
"name": "Object Identification",
"severity": "error",
"human": "Either an identifier or a reference, but not both",
"xpath": "exists(f:identifier) != exists(f:reference)"
},
{
"key": "sev-1",
"name": "Object Name",
"severity": "error",
"human": "Either a name or a query (or both)",
"xpath": "not(exists(f:name)) or not(exists(f:query))"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectIdentification"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target\n\nor\n\n.participation[typeCode=SBJ].role"
}
]
},
{
"path": "AuditEvent.object.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.object.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.object.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.object.identifier",
"short": "Specific instance of object (e.g. versioned)",
"definition": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"comments": "Identifier details depends on object type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"condition": [
"sev-2"
],
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectID"
},
{
"identity": "rim",
"map": ".id.extension"
}
]
},
{
"path": "AuditEvent.object.reference",
"short": "Specific instance of resource (e.g. versioned)",
"definition": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"sev-2"
],
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectID"
},
{
"identity": "rim",
"map": "[self]"
}
]
},
{
"path": "AuditEvent.object.type",
"short": "Object type being audited",
"definition": "Object type being audited.",
"comments": "This value is distinct from the user's role or any user relationship to the participant object.",
"requirements": "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectType",
"strength": "required",
"description": "Code for the participant object type being audited",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCode"
},
{
"identity": "rim",
"map": "[self::Act].code\nor\nrole.player.code"
}
]
},
{
"path": "AuditEvent.object.role",
"short": "Functional application role of Object",
"definition": "Code representing the functional application role of Participant Object being audited.",
"comments": "See RFC 3881 for rules concerning matches between role and type.",
"requirements": "For some detailed audit analysis it may be necessary to indicate a more granular type of participant, based on the application role it serves.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectRole",
"strength": "required",
"description": "Code representing the functional application role of Participant Object being audited",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-role"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCodeRole"
},
{
"identity": "rim",
"map": "role.code\n(not sure what this would mean for an Act)"
}
]
},
{
"path": "AuditEvent.object.lifecycle",
"short": "Life-cycle stage for the object",
"definition": "Identifier for the data life-cycle stage for the participant object.",
"comments": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements": "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectLifecycle",
"strength": "required",
"description": "Identifier for the data life-cycle stage for the participant object",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-lifecycle"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectDataLifeCycle"
},
{
"identity": "rim",
"map": "target of ObservationEvent[code=\"lifecycle\"].value"
}
]
},
{
"path": "AuditEvent.object.sensitivity",
"short": "Policy-defined sensitivity for the object",
"definition": "Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.",
"comments": "Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here.",
"requirements": "This field identifies a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventObjectSensitivity",
"strength": "example",
"description": "The sensitivity of an object in a audit event resource. May also encompass confidentiality and rudimentary access control",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-sensitivity"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectSensitivity"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "AuditEvent.object.name",
"short": "Instance-specific descriptor for Object",
"definition": "An instance-specific descriptor of the Participant Object ID audited, such as a person's name.",
"comments": "This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-1"
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectName"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "AuditEvent.object.description",
"short": "Descriptive text",
"definition": "Text that describes the object in more detail.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectDescription"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "AuditEvent.object.query",
"short": "Actual query for object",
"definition": "The actual query for a query-type participant object.",
"requirements": "For query events it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"condition": [
"sev-1"
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectQuery"
},
{
"identity": "rim",
"map": "No mapping"
}
]
},
{
"path": "AuditEvent.object.detail",
"short": "Additional Information about the Object",
"definition": "Additional Information about the Object.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectDetail"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "AuditEvent.object.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.object.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "AuditEvent.object.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "AuditEvent.object.detail.type",
"short": "Name of the property",
"definition": "Name of the property.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "AuditEvent.object.detail.value",
"short": "Property value",
"definition": "Property value.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@value"
},
{
"identity": "rim",
"map": ".value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "AuditEvent",
"short": "Event record kept for security purposes",
"definition": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comments": "Based on ATNA (RFC 3881).",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Message"
},
{
"identity": "rim",
"map": "ControlAct[moodCode=EVN]"
}
]
},
{
"path": "AuditEvent.event",
"short": "What was done",
"definition": "Identifies the name, action type, time, and disposition of the audited event.",
"requirements": "The event must be identified.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "dicom",
"map": "EventIdentification"
},
{
"identity": "rim",
"map": "N/A (no nesting in v3)"
}
]
},
{
"path": "AuditEvent.event.type",
"short": "Type/identifier of event",
"definition": "Identifier for a family of the event.",
"comments": "e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventType",
"strength": "required",
"description": "Type of event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventId"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.subtype",
"short": "More specific type/id for the event",
"definition": "Identifier for the category of event.",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventSubType",
"strength": "required",
"description": "Sub-type of event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-sub-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventTypeCode"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.action",
"short": "Type of action performed during the event",
"definition": "Indicator for type of action performed during the event that generated the audit.",
"requirements": "This broadly indicates what kind of action was done on the Participant Object.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventAction",
"strength": "required",
"description": "Indicator for type of action performed during the event that generated the audit.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-action"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventActionCode"
},
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
}
]
},
{
"path": "AuditEvent.event.dateTime",
"short": "Time when the event occurred on source",
"definition": "The time when the event occurred on the source.",
"comments": "In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic.",
"requirements": "This ties an event to a specific date and time. Security audits typically require a consistent time base, e.g., UTC, to eliminate time-zone issues arising from geographical distribution.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@EventDateTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "AuditEvent.event.outcome",
"short": "Whether the event succeeded or failed",
"definition": "Indicates whether the event succeeded or failed.",
"comments": "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventOutcome",
"strength": "required",
"description": "Indicates whether the event succeeded or failed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-outcome"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@EventOutcomeIndicator"
},
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"path": "AuditEvent.event.outcomeDesc",
"short": "Description of the event outcome",
"definition": "A free text description of the outcome of the event.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@EventOutcomeDescription"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
}
]
},
{
"path": "AuditEvent.participant",
"short": "A person, a hardware device or software process",
"definition": "A person, a hardware device or software process.",
"comments": "There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event.",
"requirements": "The event has one or more active participants.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "sev-3",
"name": "Participant Identification",
"severity": "error",
"human": "Either a userId or a reference, but not both",
"xpath": "exists(f:userId) != exists(f:reference)"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ActiveParticipant"
},
{
"identity": "rim",
"map": ".participation"
}
]
},
{
"path": "AuditEvent.participant.role",
"short": "User roles (e.g. local RBAC codes)",
"definition": "Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context.",
"requirements": "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DICOMRoleId",
"strength": "required",
"description": "Role(s) the user plays (from RBAC)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dicm-402-roleid"
}
},
"mapping": [
{
"identity": "dicom",
"map": "RoleIdCode"
},
{
"identity": "rim",
"map": ".typeCode and/or .functionCode"
}
]
},
{
"path": "AuditEvent.participant.reference",
"short": "Direct reference to resource",
"definition": "Direct reference to a resource that identifies the participant.",
"requirements": "This field ties an audit event to a specific resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"condition": [
"sev-3"
],
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "AuditEvent.participant.userId",
"short": "Unique identifier for the user",
"definition": "Unique identifier for the user actively participating in the event.",
"comments": "a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"requirements": "This field ties an audit event to a specific user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-3"
],
"mapping": [
{
"identity": "dicom",
"map": "@UserId"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AuditEvent.participant.altId",
"short": "Alternative User id e.g. authentication",
"definition": "Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available.",
"requirements": "In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AlternativeUserId"
},
{
"identity": "rim",
"map": ".id (distinguish id type by root)"
}
]
},
{
"path": "AuditEvent.participant.name",
"short": "Human-meaningful name for the user",
"definition": "Human-meaningful name for the user.",
"requirements": "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@UserName"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "AuditEvent.participant.requestor",
"short": "Whether user is initiator",
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comments": "There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator.",
"requirements": "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@UserIsRequestor"
},
{
"identity": "rim",
"map": "If participation.typeCode was author, then true"
}
]
},
{
"path": "AuditEvent.participant.location",
"short": "Where",
"definition": "Where the event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "AuditEvent.participant.policy",
"short": "Policy that authorized event",
"definition": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "AuditEvent.participant.media",
"short": "Type of media",
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements": "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "MediaType"
},
{
"identity": "rim",
"map": ".player.description.mediaType"
}
]
},
{
"path": "AuditEvent.participant.network",
"short": "Logical network location for application activity",
"definition": "Logical network location for application activity, if the activity has a network location.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player.description.reference"
}
]
},
{
"path": "AuditEvent.participant.network.identifier",
"short": "Identifier for the network access point of the user device",
"definition": "An identifier for the network access point of the user device for the audit event.",
"comments": "This could be a device id, IP address or some other identifier associated with a device.",
"requirements": "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@NetworkAccessPointID"
},
{
"identity": "rim",
"map": "pre-coordinated into URL"
}
]
},
{
"path": "AuditEvent.participant.network.type",
"short": "The type of network access point",
"definition": "An identifier for the type of network access point that originated the audit event.",
"requirements": "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventParticipantNetworkType",
"strength": "required",
"description": "The type of network access point that originated the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/network-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@NetworkAccessPointTypeCode"
},
{
"identity": "rim",
"map": "pre-coordinated into URL"
}
]
},
{
"path": "AuditEvent.source",
"short": "Application systems and processes",
"definition": "Application systems and processes.",
"comments": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants, e.g., low-level network transports, need not be identified.",
"requirements": "The event is reported by one source.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "dicom",
"map": "AuditSourceIdentification"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
}
]
},
{
"path": "AuditEvent.source.site",
"short": "Logical source location within the enterprise",
"definition": "Logical source location within the healthcare enterprise network.",
"comments": "a hospital or other provider location within a multi-entity provider group.",
"requirements": "This value differentiates among the sites in a multi-site enterprise health information system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AuditEnterpriseSiteId"
},
{
"identity": "rim",
"map": ".scopedRole[classCode=LOCE].player.desc"
}
]
},
{
"path": "AuditEvent.source.identifier",
"short": "The id of source where event originated",
"definition": "Identifier of the source where the event originated.",
"requirements": "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event occurred.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@AuditSourceId"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "AuditEvent.source.type",
"short": "The type of source where event originated",
"definition": "Code specifying the type of source where event originated.",
"requirements": "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AuditEventSourceType",
"strength": "required",
"description": "Code specifying the type of source where event originated",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-source-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "AuditSourceTypeCode"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "AuditEvent.object",
"short": "Specific instances of data or objects that have been accessed",
"definition": "Specific instances of data or objects that have been accessed.",
"comments": "required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values.",
"requirements": "The event may have other objects involved.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "sev-2",
"name": "Object Identification",
"severity": "error",
"human": "Either an identifier or a reference, but not both",
"xpath": "exists(f:identifier) != exists(f:reference)"
},
{
"key": "sev-1",
"name": "Object Name",
"severity": "error",
"human": "Either a name or a query (or both)",
"xpath": "not(exists(f:name)) or not(exists(f:query))"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectIdentification"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target\n\nor\n\n.participation[typeCode=SBJ].role"
}
]
},
{
"path": "AuditEvent.object.identifier",
"short": "Specific instance of object (e.g. versioned)",
"definition": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"comments": "Identifier details depends on object type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"condition": [
"sev-2"
],
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectID"
},
{
"identity": "rim",
"map": ".id.extension"
}
]
},
{
"path": "AuditEvent.object.reference",
"short": "Specific instance of resource (e.g. versioned)",
"definition": "Identifies a specific instance of the participant object. The reference should always be version specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"sev-2"
],
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectID"
},
{
"identity": "rim",
"map": "[self]"
}
]
},
{
"path": "AuditEvent.object.type",
"short": "Object type being audited",
"definition": "Object type being audited.",
"comments": "This value is distinct from the user's role or any user relationship to the participant object.",
"requirements": "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectType",
"strength": "required",
"description": "Code for the participant object type being audited",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-type"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCode"
},
{
"identity": "rim",
"map": "[self::Act].code\nor\nrole.player.code"
}
]
},
{
"path": "AuditEvent.object.role",
"short": "Functional application role of Object",
"definition": "Code representing the functional application role of Participant Object being audited.",
"comments": "See RFC 3881 for rules concerning matches between role and type.",
"requirements": "For some detailed audit analysis it may be necessary to indicate a more granular type of participant, based on the application role it serves.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectRole",
"strength": "required",
"description": "Code representing the functional application role of Participant Object being audited",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-role"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectTypeCodeRole"
},
{
"identity": "rim",
"map": "role.code\n(not sure what this would mean for an Act)"
}
]
},
{
"path": "AuditEvent.object.lifecycle",
"short": "Life-cycle stage for the object",
"definition": "Identifier for the data life-cycle stage for the participant object.",
"comments": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements": "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AuditEventObjectLifecycle",
"strength": "required",
"description": "Identifier for the data life-cycle stage for the participant object",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/object-lifecycle"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectDataLifeCycle"
},
{
"identity": "rim",
"map": "target of ObservationEvent[code=\"lifecycle\"].value"
}
]
},
{
"path": "AuditEvent.object.sensitivity",
"short": "Policy-defined sensitivity for the object",
"definition": "Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.",
"comments": "Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here.",
"requirements": "This field identifies a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AuditEventObjectSensitivity",
"strength": "example",
"description": "The sensitivity of an object in a audit event resource. May also encompass confidentiality and rudimentary access control",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/audit-event-sensitivity"
}
},
"mapping": [
{
"identity": "dicom",
"map": "@ParticipantObjectSensitivity"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "AuditEvent.object.name",
"short": "Instance-specific descriptor for Object",
"definition": "An instance-specific descriptor of the Participant Object ID audited, such as a person's name.",
"comments": "This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-1"
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectName"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "AuditEvent.object.description",
"short": "Descriptive text",
"definition": "Text that describes the object in more detail.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectDescription"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "AuditEvent.object.query",
"short": "Actual query for object",
"definition": "The actual query for a query-type participant object.",
"requirements": "For query events it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"condition": [
"sev-1"
],
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectQuery"
},
{
"identity": "rim",
"map": "No mapping"
}
]
},
{
"path": "AuditEvent.object.detail",
"short": "Additional Information about the Object",
"definition": "Additional Information about the Object.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "dicom",
"map": "ParticipantObjectDetail"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "AuditEvent.object.detail.type",
"short": "Name of the property",
"definition": "Name of the property.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "AuditEvent.object.detail.value",
"short": "Property value",
"definition": "Property value.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"mapping": [
{
"identity": "dicom",
"map": "@value"
},
{
"identity": "rim",
"map": ".value"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Basic",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Basic",
"name": "Basic",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Basic Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Basic",
"short": "Resource for non-supported content",
"definition": "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"requirements": "Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.",
"alias": [
"Z-resource",
"Extension-resource",
"Custom-resource"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Basic"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act, Entity or Role"
}
]
},
{
"path": "Basic.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Basic.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Basic.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Basic.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Basic.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Basic.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Basic.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Basic.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Basic.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "./identifier"
}
]
},
{
"path": "Basic.code",
"short": "Kind of Resource",
"definition": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comments": "Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.",
"requirements": "Must be able to distinguish different types of \"basic\" resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "BasicResourceType",
"strength": "example",
"description": "Codes for identifying types of resources not yet defined by FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/basic-resource-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Basic.subject",
"short": "Identifies the",
"definition": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
"comments": "Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements": "Needed for partitioning the resource by Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Basic.author",
"short": "Who created",
"definition": "Indicates who was responsible for creating the resource instance.",
"requirements": "Needed for partitioning the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Basic.created",
"short": "When created",
"definition": "Identifies when the resource was first created.",
"requirements": "Allows ordering resource instances by time.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Basic",
"short": "Resource for non-supported content",
"definition": "Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.",
"requirements": "Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.",
"alias": [
"Z-resource",
"Extension-resource",
"Custom-resource"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act, Entity or Role"
}
]
},
{
"path": "Basic.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "./identifier"
}
]
},
{
"path": "Basic.code",
"short": "Kind of Resource",
"definition": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comments": "Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.",
"requirements": "Must be able to distinguish different types of \"basic\" resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "BasicResourceType",
"strength": "example",
"description": "Codes for identifying types of resources not yet defined by FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/basic-resource-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Basic.subject",
"short": "Identifies the",
"definition": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
"comments": "Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements": "Needed for partitioning the resource by Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Basic.author",
"short": "Who created",
"definition": "Indicates who was responsible for creating the resource instance.",
"requirements": "Needed for partitioning the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Basic.created",
"short": "When created",
"definition": "Identifies when the resource was first created.",
"requirements": "Allows ordering resource instances by time.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Binary",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Binary",
"name": "Binary",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Binary Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Binary",
"short": "Pure binary content defined by sime other format than FHIR",
"definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"comments": "Typically, Binary resources are used for handling content such as:\n\n* CDA Documents (i.e. with XDS)\n* PDF Documents\n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
"requirements": "There are situations where it is useful or required to handle pure binary content using the same framework as other resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Binary"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Binary.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Binary.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Binary.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Binary.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Binary.contentType",
"short": "MimeType of the binary content",
"definition": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Binary.content",
"short": "The actual content",
"definition": "The actual content, base64 encoded.",
"comments": "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Binary",
"short": "Pure binary content defined by sime other format than FHIR",
"definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
"comments": "Typically, Binary resources are used for handling content such as:\n\n* CDA Documents (i.e. with XDS)\n* PDF Documents\n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
"requirements": "There are situations where it is useful or required to handle pure binary content using the same framework as other resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Binary.contentType",
"short": "MimeType of the binary content",
"definition": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Binary.content",
"short": "The actual content",
"definition": "The actual content, base64 encoded.",
"comments": "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "BodySite",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/BodySite",
"name": "BodySite",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for BodySite Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "openehr",
"uri": "http://openehr.org",
"name": "Open EHR"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "BodySite",
"short": "Specific and identified anatomical location",
"definition": "Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"alias": [
"anatomical location"
],
"min": 1,
"max": "1",
"type": [
{
"code": "BodySite"
}
],
"mapping": [
{
"identity": "openehr",
"map": "Archetype ID openEHR-EHR-CLUSTER.anatomical_location.v1 \nConcept name Anatomical Location \nConcept description Record details about an anatomical location. \nKeywords location, site, anatomical \nCopyright © openEHR Foundation \nPurpose To record details about anatomical location. \nMisuse Not for specifiying unilateral/bilateral occurence - this is related to an evaluation which perhaps includes multiple locations. \nAuthor Author name: Heather Leslie\nOrganisation: Ocean Informatics\nEmail: heather.leslie@oceaninformatics.com\nDate of Origination: 2008-11-10\n \nTranslator Norwegian Bokmål: Lars Bitsch-Larsen, Haukeland University Hospital of Bergen, Norway, MD, DEAA, MBA, spec in anesthesia, spec in tropical medicine.\nArabic (Syria): Mona Saleh\n \nOther contributors Heather Leslie, Ocean Informatics, Australia (Editor)\nIan McNicoll, freshEHR Clinical Informatics, United Kingdom (Editor)\nDunmail Hodkinson, Black Pear Software Ltd, UK \nReferences Use cases: - 5LICS, midclavicular line - L forearm, 2cm anterior to the cubital fossa - Right iliac fossa - 5 cm below L tibial tuberosity - 2 cm medial to R nipple - 4 cm below R costal margin in midclavicular line - R femur - midline nose - medial aspect of R great toe nail."
}
]
},
{
"path": "BodySite.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "BodySite.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "BodySite.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "BodySite.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "BodySite.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "BodySite.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "BodySite.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "BodySite.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "BodySite.patient",
"short": "Patient",
"definition": "The person to which the body site belongs.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true
},
{
"path": "BodySite.identifier",
"short": "Bodysite identifier",
"definition": "Identifier for this instance of the anatomical location.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "openehr",
"map": "Specific location\n Cluster\nOptional (0..1)\nCardinality: Mandatory, repeating, unordered (1..*)"
}
]
},
{
"path": "BodySite.code",
"short": "Named anatomical location",
"definition": "Named anatomical location - ideally would be coded where possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "openehr",
"map": "Name of location"
}
]
},
{
"path": "BodySite.modifier",
"short": "Modification to location code",
"definition": "Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "BodySiteModifier",
"strength": "example",
"description": "Concepts modifying the anatomic location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/bodysite-relative-location"
}
},
"mapping": [
{
"identity": "openehr",
"map": "Combines Side, Numerical identifier, Anatomical plane,and Aspect"
}
]
},
{
"path": "BodySite.description",
"short": "The Description of anatomical location",
"definition": "Description of anatomical location.",
"comments": "This Description could include any visual markings used to orientate the viewer e.g external reference points, special sutures, ink markings.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "openehr",
"map": "Description of anatomical location/Visual markings/orientation"
}
]
},
{
"path": "BodySite.image",
"short": "Attached images",
"definition": "Image or images used to identify a location.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "openehr",
"map": "Image"
}
]
}
]
},
"differential": {
"element": [
{
"path": "BodySite",
"short": "Specific and identified anatomical location",
"definition": "Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.",
"alias": [
"anatomical location"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "openehr",
"map": "Archetype ID openEHR-EHR-CLUSTER.anatomical_location.v1 \nConcept name Anatomical Location \nConcept description Record details about an anatomical location. \nKeywords location, site, anatomical \nCopyright © openEHR Foundation \nPurpose To record details about anatomical location. \nMisuse Not for specifiying unilateral/bilateral occurence - this is related to an evaluation which perhaps includes multiple locations. \nAuthor Author name: Heather Leslie\nOrganisation: Ocean Informatics\nEmail: heather.leslie@oceaninformatics.com\nDate of Origination: 2008-11-10\n \nTranslator Norwegian Bokmål: Lars Bitsch-Larsen, Haukeland University Hospital of Bergen, Norway, MD, DEAA, MBA, spec in anesthesia, spec in tropical medicine.\nArabic (Syria): Mona Saleh\n \nOther contributors Heather Leslie, Ocean Informatics, Australia (Editor)\nIan McNicoll, freshEHR Clinical Informatics, United Kingdom (Editor)\nDunmail Hodkinson, Black Pear Software Ltd, UK \nReferences Use cases: - 5LICS, midclavicular line - L forearm, 2cm anterior to the cubital fossa - Right iliac fossa - 5 cm below L tibial tuberosity - 2 cm medial to R nipple - 4 cm below R costal margin in midclavicular line - R femur - midline nose - medial aspect of R great toe nail."
}
]
},
{
"path": "BodySite.patient",
"short": "Patient",
"definition": "The person to which the body site belongs.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true
},
{
"path": "BodySite.identifier",
"short": "Bodysite identifier",
"definition": "Identifier for this instance of the anatomical location.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "openehr",
"map": "Specific location\n Cluster\nOptional (0..1)\nCardinality: Mandatory, repeating, unordered (1..*)"
}
]
},
{
"path": "BodySite.code",
"short": "Named anatomical location",
"definition": "Named anatomical location - ideally would be coded where possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "openehr",
"map": "Name of location"
}
]
},
{
"path": "BodySite.modifier",
"short": "Modification to location code",
"definition": "Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "BodySiteModifier",
"strength": "example",
"description": "Concepts modifying the anatomic location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/bodysite-relative-location"
}
},
"mapping": [
{
"identity": "openehr",
"map": "Combines Side, Numerical identifier, Anatomical plane,and Aspect"
}
]
},
{
"path": "BodySite.description",
"short": "The Description of anatomical location",
"definition": "Description of anatomical location.",
"comments": "This Description could include any visual markings used to orientate the viewer e.g external reference points, special sutures, ink markings.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "openehr",
"map": "Description of anatomical location/Visual markings/orientation"
}
]
},
{
"path": "BodySite.image",
"short": "Attached images",
"definition": "Image or images used to identify a location.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "openehr",
"map": "Image"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Bundle",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Bundle",
"name": "Bundle",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Bundle Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Bundle",
"short": "Contains a collection of resources",
"definition": "A container for a collection of resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Bundle"
}
],
"constraint": [
{
"key": "bdl-2",
"name": "entry.search",
"severity": "error",
"human": "entry.search only when a search",
"xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')"
},
{
"key": "bdl-1",
"name": "total",
"severity": "error",
"human": "total only when a search or history",
"xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"
},
{
"key": "bdl-3",
"name": "entry.transaction",
"severity": "error",
"human": "entry.transaction when (and only when) a transaction",
"xpath": "not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history')"
},
{
"key": "bdl-4",
"name": "entry.transactionResponse",
"severity": "error",
"human": "entry.transactionResponse when (and only when) a transaction-response",
"xpath": "not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response')"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Bundle.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Bundle.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Bundle.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Bundle.type",
"short": "document | message | transaction | transaction-response | history | searchset | collection",
"definition": "Indicates the purpose of this bundle- how it was intended to be used.",
"comments": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "BundleType",
"strength": "required",
"description": "Indicates the purpose of a bundle- how it was intended to be used",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/bundle-type"
}
}
},
{
"path": "Bundle.base",
"short": "Stated Base URL",
"definition": "The base URL for the service that provided these resources. All relative URLs are relative to this one (equivalent to xml:base).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.total",
"short": "If search, the total number of matches",
"definition": "If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).",
"comments": "Only used if the bundle is a search result set.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"bdl-1"
]
},
{
"path": "Bundle.link",
"name": "link",
"short": "Links related to this Bundle",
"definition": "A series of links that provide context to this bundle.",
"min": 0,
"max": "*"
},
{
"path": "Bundle.link.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.link.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.link.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.link.relation",
"short": "http://www.iana.org/assignments/link-relations/link-relations.xhtml",
"definition": "A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.link.url",
"short": "Reference details for the link",
"definition": "The reference details for the link.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry",
"short": "Entry in the bundle - will have a resource, or information",
"definition": "An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "bdl-5",
"name": "entry.resource",
"severity": "error",
"human": "must be a resource unless there's a transaction or transaction response",
"xpath": "f:resource or f:transaction or f:transactionResponse"
}
]
},
{
"path": "Bundle.entry.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.entry.base",
"short": "Base URL, if different to bundle base",
"definition": "The Base URL for the resource, if different to the base URL specified for the bundle as a whole.",
"comments": "This allows bundles to be composed of resources from multiple servers (collated search, documents etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.link",
"short": "Links related to this entry",
"definition": "A series of links that provide context to this entry.",
"min": 0,
"max": "*",
"nameReference": "link"
},
{
"path": "Bundle.entry.resource",
"short": "Resources in this bundle",
"definition": "The Resources for the entry.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
]
},
{
"path": "Bundle.entry.search",
"short": "Search related information",
"definition": "Information about the search process that lead to the creation of this entry.",
"min": 0,
"max": "1",
"condition": [
"bdl-2"
]
},
{
"path": "Bundle.entry.search.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.search.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.search.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.entry.search.mode",
"short": "match | include - why this is in the result set",
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchEntryMode",
"strength": "required",
"description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-entry-mode"
}
}
},
{
"path": "Bundle.entry.search.score",
"short": "Search ranking (between 0 and 1)",
"definition": "When searching, the server's search ranking score for the entry.",
"comments": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Bundle.entry.transaction",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"min": 0,
"max": "1",
"condition": [
"bdl-3"
]
},
{
"path": "Bundle.entry.transaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.transaction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.transaction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.entry.transaction.method",
"short": "GET | POST | PUT | DELETE",
"definition": "The HTTP verb for this entry in either a update history, or a transaction/ transaction response.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "HTTPVerb",
"strength": "required",
"description": "HTTP verbs (in the HTTP command line)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/http-verb"
}
}
},
{
"path": "Bundle.entry.transaction.url",
"short": "The URL for the transaction",
"definition": "A search URL for this resource that specifies how the resource is matched to an existing resource when processing a transaction (see transaction documentation).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.transaction.ifNoneMatch",
"short": "For managing cache currency",
"definition": "If the ETag values match, return a 304 Not modified status. See the read/vread interaction documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transaction.ifMatch",
"short": "For managing update contention",
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section \"Managing Resource Contention\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transaction.ifModifiedSince",
"short": "For managing update contention",
"definition": "Only perform the operation if the last updated date matches. For more information, see the API section \"Managing Resource Contention\".",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Bundle.entry.transaction.ifNoneExist",
"short": "For conditional creates",
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see \"Conditional Create\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"min": 0,
"max": "1",
"condition": [
"bdl-4"
]
},
{
"path": "Bundle.entry.transactionResponse.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.transactionResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Bundle.entry.transactionResponse.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.entry.transactionResponse.status",
"short": "Status return code for entry",
"definition": "The status code returned by processing this entry.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse.location",
"short": "The location, if the operation returns a location",
"definition": "The location header created by processing this operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.transactionResponse.etag",
"short": "The etag for the resource (if relevant)",
"definition": "The etag for the resource, it the operation for the entry produced a versioned resource.",
"comments": "This has to match the version id in the header if a resource is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse.lastModified",
"short": "Server's date time modified",
"definition": "The date/time that the resource was modified on the server.",
"comments": "This has to match the same time in the meta header if a resource is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Bundle.signature",
"short": "XML Digital Signature (base64 encoded)",
"definition": "XML Digital Signature - base64 encoded.",
"comments": "This is base 64 encoded to address issues with json/xml.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Bundle",
"short": "Contains a collection of resources",
"definition": "A container for a collection of resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "bdl-2",
"name": "entry.search",
"severity": "error",
"human": "entry.search only when a search",
"xpath": "not(f:entry/f:search) or (f:type/@value = 'searchset')"
},
{
"key": "bdl-1",
"name": "total",
"severity": "error",
"human": "total only when a search or history",
"xpath": "not(f:total) or (f:type/@value = 'searchset') or (f:type/@value = 'history')"
},
{
"key": "bdl-3",
"name": "entry.transaction",
"severity": "error",
"human": "entry.transaction when (and only when) a transaction",
"xpath": "not(f:entry/f:transaction) or (f:type/@value = 'transaction') or (f:type/@value = 'history')"
},
{
"key": "bdl-4",
"name": "entry.transactionResponse",
"severity": "error",
"human": "entry.transactionResponse when (and only when) a transaction-response",
"xpath": "not(f:entry/f:transactionResponse) or (f:type/@value = 'transaction-response')"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Bundle.type",
"short": "document | message | transaction | transaction-response | history | searchset | collection",
"definition": "Indicates the purpose of this bundle- how it was intended to be used.",
"comments": "It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "BundleType",
"strength": "required",
"description": "Indicates the purpose of a bundle- how it was intended to be used",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/bundle-type"
}
}
},
{
"path": "Bundle.base",
"short": "Stated Base URL",
"definition": "The base URL for the service that provided these resources. All relative URLs are relative to this one (equivalent to xml:base).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.total",
"short": "If search, the total number of matches",
"definition": "If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).",
"comments": "Only used if the bundle is a search result set.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"bdl-1"
]
},
{
"path": "Bundle.link",
"name": "link",
"short": "Links related to this Bundle",
"definition": "A series of links that provide context to this bundle.",
"min": 0,
"max": "*"
},
{
"path": "Bundle.link.relation",
"short": "http://www.iana.org/assignments/link-relations/link-relations.xhtml",
"definition": "A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]].",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.link.url",
"short": "Reference details for the link",
"definition": "The reference details for the link.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry",
"short": "Entry in the bundle - will have a resource, or information",
"definition": "An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "bdl-5",
"name": "entry.resource",
"severity": "error",
"human": "must be a resource unless there's a transaction or transaction response",
"xpath": "f:resource or f:transaction or f:transactionResponse"
}
]
},
{
"path": "Bundle.entry.base",
"short": "Base URL, if different to bundle base",
"definition": "The Base URL for the resource, if different to the base URL specified for the bundle as a whole.",
"comments": "This allows bundles to be composed of resources from multiple servers (collated search, documents etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.link",
"short": "Links related to this entry",
"definition": "A series of links that provide context to this entry.",
"min": 0,
"max": "*",
"nameReference": "link"
},
{
"path": "Bundle.entry.resource",
"short": "Resources in this bundle",
"definition": "The Resources for the entry.",
"min": 0,
"max": "1",
"type": [
{
"code": "Resource"
}
]
},
{
"path": "Bundle.entry.search",
"short": "Search related information",
"definition": "Information about the search process that lead to the creation of this entry.",
"min": 0,
"max": "1",
"condition": [
"bdl-2"
]
},
{
"path": "Bundle.entry.search.mode",
"short": "match | include - why this is in the result set",
"definition": "Why this entry is in the result set - whether it's included as a match or because of an _include requirement.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchEntryMode",
"strength": "required",
"description": "Why an entry is in the result set - whether it's included as a match or because of an _include requirement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-entry-mode"
}
}
},
{
"path": "Bundle.entry.search.score",
"short": "Search ranking (between 0 and 1)",
"definition": "When searching, the server's search ranking score for the entry.",
"comments": "Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Bundle.entry.transaction",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"min": 0,
"max": "1",
"condition": [
"bdl-3"
]
},
{
"path": "Bundle.entry.transaction.method",
"short": "GET | POST | PUT | DELETE",
"definition": "The HTTP verb for this entry in either a update history, or a transaction/ transaction response.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "HTTPVerb",
"strength": "required",
"description": "HTTP verbs (in the HTTP command line)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/http-verb"
}
}
},
{
"path": "Bundle.entry.transaction.url",
"short": "The URL for the transaction",
"definition": "A search URL for this resource that specifies how the resource is matched to an existing resource when processing a transaction (see transaction documentation).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.transaction.ifNoneMatch",
"short": "For managing cache currency",
"definition": "If the ETag values match, return a 304 Not modified status. See the read/vread interaction documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transaction.ifMatch",
"short": "For managing update contention",
"definition": "Only perform the operation if the Etag value matches. For more information, see the API section \"Managing Resource Contention\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transaction.ifModifiedSince",
"short": "For managing update contention",
"definition": "Only perform the operation if the last updated date matches. For more information, see the API section \"Managing Resource Contention\".",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Bundle.entry.transaction.ifNoneExist",
"short": "For conditional creates",
"definition": "Instruct the server not to perform the create if a specified resource already exists. For further information, see \"Conditional Create\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse",
"short": "Transaction Related Information",
"definition": "Additional information about how this entry should be processed as part of a transaction.",
"min": 0,
"max": "1",
"condition": [
"bdl-4"
]
},
{
"path": "Bundle.entry.transactionResponse.status",
"short": "Status return code for entry",
"definition": "The status code returned by processing this entry.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse.location",
"short": "The location, if the operation returns a location",
"definition": "The location header created by processing this operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Bundle.entry.transactionResponse.etag",
"short": "The etag for the resource (if relevant)",
"definition": "The etag for the resource, it the operation for the entry produced a versioned resource.",
"comments": "This has to match the version id in the header if a resource is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Bundle.entry.transactionResponse.lastModified",
"short": "Server's date time modified",
"definition": "The date/time that the resource was modified on the server.",
"comments": "This has to match the same time in the meta header if a resource is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Bundle.signature",
"short": "XML Digital Signature (base64 encoded)",
"definition": "XML Digital Signature - base64 encoded.",
"comments": "This is base 64 encoded to address issues with json/xml.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "CarePlan",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"name": "CarePlan",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for CarePlan Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "CarePlan",
"short": "Healthcare plan for patient",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CarePlan"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
}
]
},
{
"path": "CarePlan.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "CarePlan.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "CarePlan.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "CarePlan.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "CarePlan.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "CarePlan.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.identifier",
"short": "External Ids for this plan",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "CarePlan.patient",
"short": "Who care plan is for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Care plans are associated with the patient the plan is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "CarePlan.status",
"short": "planned | active | completed",
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CarePlanStatus",
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5-pathway life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nplanned = new\nactive = active\ncompleted = completed"
}
]
},
{
"path": "CarePlan.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "PTH-6-change pathway life cycle status date/time"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "CarePlan.concern",
"short": "Health issues this plan addresses",
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"requirements": "Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-4-Problem instance ID"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"path": "CarePlan.participant",
"short": "Who's involved in plan?",
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.participant.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.participant.role",
"short": "Type of involvement",
"definition": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"comments": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlanParticipantRole",
"strength": "required",
"description": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"mapping": [
{
"identity": "v2",
"map": "REL.2 (or PRT-4-participation?)"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "CarePlan.participant.member",
"short": "Who is involved",
"definition": "The specific person or organization who is participating/expected to participate in the care plan.",
"comments": "Patient only needs to be listed if they have a role other than \"subject of care\".",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL.5 (or PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization?)"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "CarePlan.goal",
"short": "Desired outcome of plan",
"definition": "Describes the intended objective(s) of carrying out the Care Plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "CarePlan.goal.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.goal.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.goal.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.goal.description",
"short": "What's the desired outcome?",
"definition": "Human-readable description of a specific desired objective of the care plan.",
"requirements": "Without a description of what's trying to be achieved, element has no purpose.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "CarePlan.goal.status",
"short": "in-progress | achieved | sustaining | cancelled",
"definition": "Indicates whether the goal has been reached and is still considered relevant.",
"requirements": "Allows measuring outcome and also indicates relevance of goal to plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanGoalStatus",
"strength": "required",
"description": "Indicates whether the goal has been met and is still being targeted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-goal-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nin-progress = active (classCode = OBJ)\nachieved = complete\nsustaining = active (classCode=OBJC)\ncancelled = aborted"
}
]
},
{
"path": "CarePlan.goal.notes",
"short": "Comments about the goal",
"definition": "Any comments related to the goal.",
"comments": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan.goal.concern",
"short": "Health issues this goal addresses",
"definition": "The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.",
"comments": "The concerns do not also need to be listed under CarePlan.concern, but may be.",
"requirements": "Allows specific goals to explicitly linked to conditions - makes the plan more understandable.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
},
{
"path": "CarePlan.activity",
"short": "Action to occur as part of plan",
"definition": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements": "Allows systems to prompt for performance of planned activities, validate plans against best practice.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "CarePlan.activity.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.activity.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.activity.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.activity.goal",
"short": "Goals this activity relates to",
"definition": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"requirements": "So that participants know the link explicitly.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "CarePlan.activity.status",
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled",
"definition": "Identifies what progress is being made for the specific activity.",
"comments": "Some aspects of Status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated.",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanActivityStatus",
"strength": "required",
"description": "Indicates where the activity is at in its overall life cycle",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-5-order status?"
},
{
"identity": "rim",
"map": ".statusCode\nnot-started = new\nscheduled = not-started (and fulfillment relationship to appointent)\nin-progress = active\non-hold = suspended\ncompleted = completed\ncancelled = aborted"
}
]
},
{
"path": "CarePlan.activity.prohibited",
"short": "Do NOT do",
"definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan.",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"path": "CarePlan.activity.actionResulting",
"short": "Appointments, orders, etc.",
"definition": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"requirements": "Links plan to resulting actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"path": "CarePlan.activity.notes",
"short": "Comments about the activity",
"definition": "Notes about the execution of the activity.",
"comments": "Doesn't describe the activity - that goes in details.",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan.activity.detail",
"short": "Activity details defined in specific resource",
"definition": "The details of the proposed activity represented in a specific resource.",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
],
"condition": [
"cpl-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "CarePlan.activity.simple",
"short": "Activity details summarised here",
"definition": "A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"requirements": "Details in a simple form for generic care plan systems.",
"min": 0,
"max": "1",
"condition": [
"cpl-3"
],
"constraint": [
{
"key": "cpl-1",
"name": "dose for food or drug",
"severity": "error",
"human": "DailyDose can only be specified if activity category is drug or food",
"xpath": "(f:category/@value=('drug','diet')) = exists(f:dailyAmount)"
},
{
"key": "cpl-2",
"name": "quantity for supply",
"severity": "error",
"human": "Quantity can only be specified if activity category is supply",
"xpath": "(f:category/@value=('supply')) = exists(f:quantity)"
},
{
"key": "cpl-3",
"name": "details by reference, or simple details",
"severity": "error",
"human": "Only provide a detail reference, or a simple detail summary",
"xpath": "not(exists(f:detail)) or not(exists(f:simple))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}
]
},
{
"path": "CarePlan.activity.simple.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.activity.simple.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan.activity.simple.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan.activity.simple.category",
"short": "diet | drug | encounter | observation | procedure | supply | other",
"definition": "High-level categorization of the type of activity in a care plan.",
"requirements": "May determine what types of extensions are permitted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanActivityCategory",
"strength": "required",
"description": "High-level categorization of the type of activity in a care plan.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
},
{
"path": "CarePlan.activity.simple.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlanActivityType",
"strength": "required",
"description": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4-universal service ID / RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "CarePlan.activity.simple.scheduled[x]",
"short": "When activity is to occur",
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan.activity.simple.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may just identify a type of location.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-24-diagnostic service section ID (???!!)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
}
]
},
{
"path": "CarePlan.activity.simple.performer",
"short": "Who's responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"comments": "A performer MAY also be a participant in the care plan.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan.activity.simple.product",
"short": "What's administered/supplied",
"definition": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "CarePlan.activity.simple.dailyAmount",
"short": "How much consumed/day?",
"definition": "Identifies the quantity expected to be consumed in a given day.",
"requirements": "Allows rough dose checking.",
"alias": [
"daily dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"cpl-1"
],
"mapping": [
{
"identity": "v2",
"map": "RXO-23-total daily dose / RXE-19-total daily dose / RXD-12-total daily dose"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}
]
},
{
"path": "CarePlan.activity.simple.quantity",
"short": "How much is administered/supplied/consumed",
"definition": "Identifies the quantity expected to be supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"cpl-2"
],
"mapping": [
{
"identity": "v2",
"map": "RXO-11-requested dispense amount / RXE-10-dispense amount / RXD-4-actual dispense amount / RXG-5-give amount-minumum / RXA-6-administered amount / TQ1-2.1-quantity.quantity *and* RXO-12-requested dispense units / RXE-11-dispense units / RXD-5-actual dispense units / RXG-7-give units / RXA-7-administered units / TQ1-2.2-quantity.units"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}
]
},
{
"path": "CarePlan.activity.simple.details",
"short": "Extra info on activity occurrence",
"definition": "This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "CarePlan.notes",
"short": "Comments about the plan",
"definition": "General notes about the care plan not covered elsewhere.",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "CarePlan",
"short": "Healthcare plan for patient",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
}
]
},
{
"path": "CarePlan.identifier",
"short": "External Ids for this plan",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "CarePlan.patient",
"short": "Who care plan is for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Care plans are associated with the patient the plan is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "CarePlan.status",
"short": "planned | active | completed",
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CarePlanStatus",
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5-pathway life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nplanned = new\nactive = active\ncompleted = completed"
}
]
},
{
"path": "CarePlan.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "PTH-6-change pathway life cycle status date/time"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "CarePlan.concern",
"short": "Health issues this plan addresses",
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"requirements": "Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-4-Problem instance ID"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"path": "CarePlan.participant",
"short": "Who's involved in plan?",
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan.participant.role",
"short": "Type of involvement",
"definition": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"comments": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlanParticipantRole",
"strength": "required",
"description": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"mapping": [
{
"identity": "v2",
"map": "REL.2 (or PRT-4-participation?)"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "CarePlan.participant.member",
"short": "Who is involved",
"definition": "The specific person or organization who is participating/expected to participate in the care plan.",
"comments": "Patient only needs to be listed if they have a role other than \"subject of care\".",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL.5 (or PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization?)"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "CarePlan.goal",
"short": "Desired outcome of plan",
"definition": "Describes the intended objective(s) of carrying out the Care Plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "CarePlan.goal.description",
"short": "What's the desired outcome?",
"definition": "Human-readable description of a specific desired objective of the care plan.",
"requirements": "Without a description of what's trying to be achieved, element has no purpose.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "CarePlan.goal.status",
"short": "in-progress | achieved | sustaining | cancelled",
"definition": "Indicates whether the goal has been reached and is still considered relevant.",
"requirements": "Allows measuring outcome and also indicates relevance of goal to plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanGoalStatus",
"strength": "required",
"description": "Indicates whether the goal has been met and is still being targeted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-goal-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nin-progress = active (classCode = OBJ)\nachieved = complete\nsustaining = active (classCode=OBJC)\ncancelled = aborted"
}
]
},
{
"path": "CarePlan.goal.notes",
"short": "Comments about the goal",
"definition": "Any comments related to the goal.",
"comments": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan.goal.concern",
"short": "Health issues this goal addresses",
"definition": "The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.",
"comments": "The concerns do not also need to be listed under CarePlan.concern, but may be.",
"requirements": "Allows specific goals to explicitly linked to conditions - makes the plan more understandable.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
},
{
"path": "CarePlan.activity",
"short": "Action to occur as part of plan",
"definition": "Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements": "Allows systems to prompt for performance of planned activities, validate plans against best practice.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "CarePlan.activity.goal",
"short": "Goals this activity relates to",
"definition": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"requirements": "So that participants know the link explicitly.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "CarePlan.activity.status",
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled",
"definition": "Identifies what progress is being made for the specific activity.",
"comments": "Some aspects of Status can be inferred based on the resources linked in actionTaken. Note that \"status\" is only as current as the plan was most recently updated.",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanActivityStatus",
"strength": "required",
"description": "Indicates where the activity is at in its overall life cycle",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-5-order status?"
},
{
"identity": "rim",
"map": ".statusCode\nnot-started = new\nscheduled = not-started (and fulfillment relationship to appointent)\nin-progress = active\non-hold = suspended\ncompleted = completed\ncancelled = aborted"
}
]
},
{
"path": "CarePlan.activity.prohibited",
"short": "Do NOT do",
"definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan.",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"path": "CarePlan.activity.actionResulting",
"short": "Appointments, orders, etc.",
"definition": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"requirements": "Links plan to resulting actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"path": "CarePlan.activity.notes",
"short": "Comments about the activity",
"definition": "Notes about the execution of the activity.",
"comments": "Doesn't describe the activity - that goes in details.",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan.activity.detail",
"short": "Activity details defined in specific resource",
"definition": "The details of the proposed activity represented in a specific resource.",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
],
"condition": [
"cpl-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "CarePlan.activity.simple",
"short": "Activity details summarised here",
"definition": "A simple summary of details suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.",
"requirements": "Details in a simple form for generic care plan systems.",
"min": 0,
"max": "1",
"condition": [
"cpl-3"
],
"constraint": [
{
"key": "cpl-1",
"name": "dose for food or drug",
"severity": "error",
"human": "DailyDose can only be specified if activity category is drug or food",
"xpath": "(f:category/@value=('drug','diet')) = exists(f:dailyAmount)"
},
{
"key": "cpl-2",
"name": "quantity for supply",
"severity": "error",
"human": "Quantity can only be specified if activity category is supply",
"xpath": "(f:category/@value=('supply')) = exists(f:quantity)"
},
{
"key": "cpl-3",
"name": "details by reference, or simple details",
"severity": "error",
"human": "Only provide a detail reference, or a simple detail summary",
"xpath": "not(exists(f:detail)) or not(exists(f:simple))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}
]
},
{
"path": "CarePlan.activity.simple.category",
"short": "diet | drug | encounter | observation | procedure | supply | other",
"definition": "High-level categorization of the type of activity in a care plan.",
"requirements": "May determine what types of extensions are permitted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "CarePlanActivityCategory",
"strength": "required",
"description": "High-level categorization of the type of activity in a care plan.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan-activity-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
},
{
"path": "CarePlan.activity.simple.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlanActivityType",
"strength": "required",
"description": "Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4-universal service ID / RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "CarePlan.activity.simple.scheduled[x]",
"short": "When activity is to occur",
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan.activity.simple.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may just identify a type of location.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-24-diagnostic service section ID (???!!)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
}
]
},
{
"path": "CarePlan.activity.simple.performer",
"short": "Who's responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"comments": "A performer MAY also be a participant in the care plan.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan.activity.simple.product",
"short": "What's administered/supplied",
"definition": "Identifies the food, drug or other product being consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "CarePlan.activity.simple.dailyAmount",
"short": "How much consumed/day?",
"definition": "Identifies the quantity expected to be consumed in a given day.",
"requirements": "Allows rough dose checking.",
"alias": [
"daily dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"cpl-1"
],
"mapping": [
{
"identity": "v2",
"map": "RXO-23-total daily dose / RXE-19-total daily dose / RXD-12-total daily dose"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}
]
},
{
"path": "CarePlan.activity.simple.quantity",
"short": "How much is administered/supplied/consumed",
"definition": "Identifies the quantity expected to be supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"cpl-2"
],
"mapping": [
{
"identity": "v2",
"map": "RXO-11-requested dispense amount / RXE-10-dispense amount / RXD-4-actual dispense amount / RXG-5-give amount-minumum / RXA-6-administered amount / TQ1-2.1-quantity.quantity *and* RXO-12-requested dispense units / RXE-11-dispense units / RXD-5-actual dispense units / RXG-7-give units / RXA-7-administered units / TQ1-2.2-quantity.units"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}
]
},
{
"path": "CarePlan.activity.simple.details",
"short": "Extra info on activity occurrence",
"definition": "This provides a textual description of constraints on the activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "CarePlan.notes",
"short": "Comments about the plan",
"definition": "General notes about the care plan not covered elsewhere.",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "CarePlan2",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/CarePlan2",
"name": "CarePlan2",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for CarePlan2 Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "CarePlan2",
"short": "Healthcare plan for patient",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 1,
"max": "1",
"type": [
{
"code": "CarePlan2"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
}
]
},
{
"path": "CarePlan2.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "CarePlan2.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "CarePlan2.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "CarePlan2.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "CarePlan2.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "CarePlan2.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan2.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan2.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan2.identifier",
"short": "External Ids for this plan",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "CarePlan2.patient",
"short": "Who care plan is for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Care plans are associated with the patient the plan is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "CarePlan2.status",
"short": "planned | active | completed",
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CarePlan2Status",
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan2-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5-pathway life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nplanned = new\nactive = active\ncompleted = completed"
}
]
},
{
"path": "CarePlan2.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan2.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "PTH-6-change pathway life cycle status date/time"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "CarePlan2.concern",
"short": "Health issues this plan addresses",
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"requirements": "Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-4-Problem instance ID"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"path": "CarePlan2.participant",
"short": "Who's involved in plan?",
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan2.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan2.participant.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CarePlan2.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CarePlan2.participant.role",
"short": "Type of involvement",
"definition": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"comments": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlan2ParticipantRole",
"strength": "required",
"description": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"mapping": [
{
"identity": "v2",
"map": "REL.2 (or PRT-4-participation?)"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "CarePlan2.participant.member",
"short": "Who is involved",
"definition": "The specific person or organization who is participating/expected to participate in the care plan.",
"comments": "Patient only needs to be listed if they have a role other than \"subject of care\".",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL.5 (or PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization?)"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "CarePlan2.notes",
"short": "Comments about the plan",
"definition": "General notes about the care plan not covered elsewhere.",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan2.goal",
"short": "CarePlan Goal",
"definition": "Describes the intended objective(s) of carrying out the Care Plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
]
},
{
"path": "CarePlan2.activity",
"short": "CarePlan Activity",
"definition": "Identifies an action that is planned to happen as part of the careplan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements": "Allows systems to prompt for performance of planned activities, validate plans against best practice.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
}
]
}
]
},
"differential": {
"element": [
{
"path": "CarePlan2",
"short": "Healthcare plan for patient",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
}
]
},
{
"path": "CarePlan2.identifier",
"short": "External Ids for this plan",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "CarePlan2.patient",
"short": "Who care plan is for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Care plans are associated with the patient the plan is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "CarePlan2.status",
"short": "planned | active | completed",
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CarePlan2Status",
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/care-plan2-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5-pathway life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\nplanned = new\nactive = active\ncompleted = completed"
}
]
},
{
"path": "CarePlan2.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "CarePlan2.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "PTH-6-change pathway life cycle status date/time"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "CarePlan2.concern",
"short": "Health issues this plan addresses",
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"requirements": "Links plan to the conditions it manages. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-4-Problem instance ID"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"path": "CarePlan2.participant",
"short": "Who's involved in plan?",
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "CarePlan2.participant.role",
"short": "Type of involvement",
"definition": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc.",
"comments": "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care plan. General relationships should be handled as properties of the Patient resource directly.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CarePlan2ParticipantRole",
"strength": "required",
"description": "Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"mapping": [
{
"identity": "v2",
"map": "REL.2 (or PRT-4-participation?)"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "CarePlan2.participant.member",
"short": "Who is involved",
"definition": "The specific person or organization who is participating/expected to participate in the care plan.",
"comments": "Patient only needs to be listed if they have a role other than \"subject of care\".",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL.5 (or PRT-5-participation person : ( PRV-4 e {provider participations} ) / PRT-5-participation person : ( PRV-4 e {non-provider person participations} ) / PRT-5-participation person : ( PRV-4 = (patient non-subject of care) ) / PRT-8-participation organization?)"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "CarePlan2.notes",
"short": "Comments about the plan",
"definition": "General notes about the care plan not covered elsewhere.",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "CarePlan2.goal",
"short": "CarePlan Goal",
"definition": "Describes the intended objective(s) of carrying out the Care Plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
]
},
{
"path": "CarePlan2.activity",
"short": "CarePlan Activity",
"definition": "Identifies an action that is planned to happen as part of the careplan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.",
"requirements": "Allows systems to prompt for performance of planned activities, validate plans against best practice.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Claim",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Claim",
"name": "Claim",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Claim Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Claim",
"short": "Claim, Pre-determination or Pre-authorization",
"definition": "A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.",
"min": 1,
"max": "1",
"type": [
{
"code": "Claim"
}
]
},
{
"path": "Claim.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Claim.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Claim.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Claim.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Claim.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Claim.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.type",
"short": "institutional | oral | pharmacy | professional | vision",
"definition": "The category of claim this is.",
"comments": "Affects which fields and value sets are used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ClaimType",
"strength": "required",
"description": "The type or discipline-style of the claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/type-link"
}
}
},
{
"path": "Claim.identifier",
"short": "Claim number",
"definition": "The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Claim.ruleset",
"short": "Current specification followed",
"definition": "The version of the specification on which this instance relies.",
"alias": [
"BusinessVersion"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.originalRuleset",
"short": "Original specification followed",
"definition": "The version of the specification from which the original instance was created.",
"alias": [
"OriginalBusinessVersion"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Claim.target",
"short": "Insurer",
"definition": "Insurer Identifier, typical BIN number (6 digit).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.provider",
"short": "Responsible provider",
"definition": "The provider which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.use",
"short": "complete | proposed | exploratory | other",
"definition": "Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Use",
"strength": "required",
"description": "Complete, proposed, exploratory, other",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-link"
}
}
},
{
"path": "Claim.priority",
"short": "Desired processing priority",
"definition": "Immediate (STAT), best effort (NORMAL), deferred (DEFER).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProcessPriority",
"strength": "example",
"description": "The timeliness with which processing is required: STAT, normal, Deferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/process-priority"
}
}
},
{
"path": "Claim.fundsReserve",
"short": "Funds requested to be reserved",
"definition": "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "Claim.enterer",
"short": "Author",
"definition": "Person who created the invoice/claim/pre-determination or pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.facility",
"short": "Servicing Facility",
"definition": "Facility where the services were provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "Claim.prescription",
"short": "Prescription",
"definition": "Prescription to support the dispensing of Pharmacy or Vision products.",
"requirements": "For type=Pharmacy and Vision only.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
]
},
{
"path": "Claim.originalPrescription",
"short": "Original Prescription",
"definition": "Original prescription to support the dispensing of pharmacy services, medications or products.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
]
},
{
"path": "Claim.payee",
"short": "Payee",
"definition": "The party to be reimbursed for the services.",
"min": 0,
"max": "1"
},
{
"path": "Claim.payee.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.payee.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.payee.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.payee.type",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "Claim.payee.provider",
"short": "Provider who is the payee",
"definition": "The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.payee.organization",
"short": "Organization who is the payee",
"definition": "The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.payee.person",
"short": "Other person who is the payee",
"definition": "The person other than the subscriber who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "Claim.referral",
"short": "Treatment Referral",
"definition": "The referral resource which lists the date, practitioner, reason and other supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "Claim.diagnosis",
"short": "Diagnosis",
"definition": "Ordered list of patient diagnosis for which care is sought.",
"min": 0,
"max": "*"
},
{
"path": "Claim.diagnosis.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.diagnosis.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.diagnosis.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.diagnosis.sequence",
"short": "Sequence of diagnosis",
"definition": "Sequence of diagnosis which serves to order and provide a link.",
"requirements": "Required to maintain order of the diagnoses.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.diagnosis.diagnosis",
"short": "Patient's list of diagnosis",
"definition": "The diagnosis.",
"requirements": "Required to adjudicate services rendered to condition presented.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ICD10",
"strength": "example",
"description": "ICD10 Diagnostic codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/icd-10"
}
}
},
{
"path": "Claim.condition",
"short": "List of presenting Conditions",
"definition": "List of patient conditions for which care is sought.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Conditions",
"strength": "example",
"description": "Patient conditions and symptoms",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fm-conditions"
}
}
},
{
"path": "Claim.patient",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "Claim.coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Claim.coverage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.coverage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.coverage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.coverage.sequence",
"short": "Service instance identifier",
"definition": "A service line item.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.coverage.focal",
"short": "Is the focal Coverage",
"definition": "The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Claim.coverage.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "Claim.coverage.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.coverage.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
}
},
{
"path": "Claim.coverage.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.coverage.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
]
},
{
"path": "Claim.coverage.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.exception",
"short": "Eligibility exceptions",
"definition": "Factors which may influence the applicability of coverage.",
"requirements": "To determine extenuating circumstances for coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Exception",
"strength": "example",
"description": "The eligibility exception codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/exception"
}
}
},
{
"path": "Claim.school",
"short": "Name of School",
"definition": "Name of school for over-aged dependants.",
"requirements": "Often required for over-age dependents.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.accident",
"short": "Accident Date",
"definition": "Date of an accident which these services are addressing.",
"requirements": "Coverage may be dependant on accidents.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.accidentType",
"short": "Accident Type",
"definition": "Type of accident: work, auto, etc.",
"requirements": "Coverage may be dependant on the type of accident.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AccidentType",
"strength": "example",
"description": "Type of accident: work place, auto, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActIncidentCode"
}
}
},
{
"path": "Claim.interventionException",
"short": "Intervention and exception code (Pharma)",
"definition": "A list of intervention and exception codes which may influence the adjudication of the claim.",
"requirements": "Coverage may be modified based on exception information provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Intervention",
"strength": "example",
"description": "Intervention and exception codes (Pharm)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/intervention"
}
}
},
{
"path": "Claim.item",
"short": "Goods and Services",
"definition": "First tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.item.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.type",
"short": "Group or type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.item.diagnosisLinkId",
"short": "Diagnosis Link",
"definition": "Diagnosis applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.service",
"short": "Item Code",
"definition": "If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.serviceDate",
"short": "Date of Service",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.item.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.net",
"short": "Total item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.bodySite",
"short": "Service Location",
"definition": "Physical service site on the patient (limb, tooth, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "OralSites",
"strength": "example",
"description": "The code for the teeth, quadrant, sextant and arch",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/tooth"
}
}
},
{
"path": "Claim.item.subSite",
"short": "Service Sub-location",
"definition": "A region or surface of the site, eg. limb region or tooth surface(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Surface",
"strength": "example",
"description": "The code for the tooth surface and surface combinations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/surface"
}
}
},
{
"path": "Claim.item.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Modifiers",
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modifiers"
}
}
},
{
"path": "Claim.item.detail",
"short": "Additional items",
"definition": "Second tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.item.detail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.detail.type",
"short": "Group or type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.detail.service",
"short": "Additional item codes",
"definition": "If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.detail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.detail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.net",
"short": "Total additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.detail.subDetail",
"short": "Additional items",
"definition": "Third tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.detail.subDetail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.detail.subDetail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.detail.subDetail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.item.detail.subDetail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.detail.subDetail.type",
"short": "Type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.detail.subDetail.service",
"short": "Additional item codes",
"definition": "The fee for an addittional service or product or charge.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.detail.subDetail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.detail.subDetail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "The fee for an addittional service or product or charge.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.subDetail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.subDetail.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.subDetail.net",
"short": "Net additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.subDetail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.prosthesis",
"short": "Prosthetic details",
"definition": "The materials and placement date of prior fixed prosthesis.",
"min": 0,
"max": "1"
},
{
"path": "Claim.item.prosthesis.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.prosthesis.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.item.prosthesis.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.item.prosthesis.initial",
"short": "Is this the initial service",
"definition": "Indicates whether this is the initial placement of a fixed prosthesis.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Claim.item.prosthesis.priorDate",
"short": "Initial service Date",
"definition": "Date of the initial placement.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.item.prosthesis.priorMaterial",
"short": "Prosthetic Material",
"definition": "Material of the prior denture or bridge prosthesis. (Oral).",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "OralProsthoMaterial",
"strength": "example",
"description": "Material of the prior denture or bridge prosthesis. (Oral)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/oral-prosthodontic-material"
}
}
},
{
"path": "Claim.additionalMaterials",
"short": "Additional materials, documents, etc.",
"definition": "Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdditionalMaterials",
"strength": "example",
"description": "Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/additionalmaterials"
}
}
},
{
"path": "Claim.missingTeeth",
"short": "Only if type = oral",
"definition": "A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.",
"requirements": "The list of missing teeth may influence the adjudication of services for example with Bridges.",
"min": 0,
"max": "*"
},
{
"path": "Claim.missingTeeth.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.missingTeeth.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Claim.missingTeeth.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Claim.missingTeeth.tooth",
"short": "Tooth Code",
"definition": "The code identifying which tooth is missing.",
"requirements": "Provides the tooth number of the missing tooth.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Tooth",
"strength": "example",
"description": "The codes for the teeth, subset of OralSites",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/teeth"
}
}
},
{
"path": "Claim.missingTeeth.reason",
"short": "Reason for missing",
"definition": "Missing reason may be: E-extraction, O-other.",
"requirements": "Provides the reason for the missing tooth.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MissingReason",
"strength": "example",
"description": "Reason codes for the missing teeth",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/missing-tooth-reason"
}
}
},
{
"path": "Claim.missingTeeth.extractionDate",
"short": "Date of Extraction",
"definition": "The date of the extraction either known from records or patient reported estimate.",
"requirements": "Some services and adjudications require this information.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Claim",
"short": "Claim, Pre-determination or Pre-authorization",
"definition": "A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "Claim.type",
"short": "institutional | oral | pharmacy | professional | vision",
"definition": "The category of claim this is.",
"comments": "Affects which fields and value sets are used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ClaimType",
"strength": "required",
"description": "The type or discipline-style of the claim",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/type-link"
}
}
},
{
"path": "Claim.identifier",
"short": "Claim number",
"definition": "The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Claim.ruleset",
"short": "Current specification followed",
"definition": "The version of the specification on which this instance relies.",
"alias": [
"BusinessVersion"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.originalRuleset",
"short": "Original specification followed",
"definition": "The version of the specification from which the original instance was created.",
"alias": [
"OriginalBusinessVersion"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Claim.target",
"short": "Insurer",
"definition": "Insurer Identifier, typical BIN number (6 digit).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.provider",
"short": "Responsible provider",
"definition": "The provider which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the bill, claim pre-determination, pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.use",
"short": "complete | proposed | exploratory | other",
"definition": "Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Use",
"strength": "required",
"description": "Complete, proposed, exploratory, other",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-link"
}
}
},
{
"path": "Claim.priority",
"short": "Desired processing priority",
"definition": "Immediate (STAT), best effort (NORMAL), deferred (DEFER).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProcessPriority",
"strength": "example",
"description": "The timeliness with which processing is required: STAT, normal, Deferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/process-priority"
}
}
},
{
"path": "Claim.fundsReserve",
"short": "Funds requested to be reserved",
"definition": "In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved ('Patient' or 'Provider') to pay for the Benefits determined on the subsequent claim(s). 'None' explicitly indicates no funds reserving is requested.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "Claim.enterer",
"short": "Author",
"definition": "Person who created the invoice/claim/pre-determination or pre-authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.facility",
"short": "Servicing Facility",
"definition": "Facility where the services were provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "Claim.prescription",
"short": "Prescription",
"definition": "Prescription to support the dispensing of Pharmacy or Vision products.",
"requirements": "For type=Pharmacy and Vision only.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
]
},
{
"path": "Claim.originalPrescription",
"short": "Original Prescription",
"definition": "Original prescription to support the dispensing of pharmacy services, medications or products.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
]
},
{
"path": "Claim.payee",
"short": "Payee",
"definition": "The party to be reimbursed for the services.",
"min": 0,
"max": "1"
},
{
"path": "Claim.payee.type",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "Claim.payee.provider",
"short": "Provider who is the payee",
"definition": "The provider who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.payee.organization",
"short": "Organization who is the payee",
"definition": "The organization who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Claim.payee.person",
"short": "Other person who is the payee",
"definition": "The person other than the subscriber who is to be reimbursed for the claim (the party to whom any benefit is assigned).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "Claim.referral",
"short": "Treatment Referral",
"definition": "The referral resource which lists the date, practitioner, reason and other supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "Claim.diagnosis",
"short": "Diagnosis",
"definition": "Ordered list of patient diagnosis for which care is sought.",
"min": 0,
"max": "*"
},
{
"path": "Claim.diagnosis.sequence",
"short": "Sequence of diagnosis",
"definition": "Sequence of diagnosis which serves to order and provide a link.",
"requirements": "Required to maintain order of the diagnoses.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.diagnosis.diagnosis",
"short": "Patient's list of diagnosis",
"definition": "The diagnosis.",
"requirements": "Required to adjudicate services rendered to condition presented.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ICD10",
"strength": "example",
"description": "ICD10 Diagnostic codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/icd-10"
}
}
},
{
"path": "Claim.condition",
"short": "List of presenting Conditions",
"definition": "List of patient conditions for which care is sought.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Conditions",
"strength": "example",
"description": "Patient conditions and symptoms",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fm-conditions"
}
}
},
{
"path": "Claim.patient",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "Claim.coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Claim.coverage.sequence",
"short": "Service instance identifier",
"definition": "A service line item.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.coverage.focal",
"short": "Is the focal Coverage",
"definition": "The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Claim.coverage.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "Claim.coverage.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.coverage.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
}
},
{
"path": "Claim.coverage.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.coverage.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
]
},
{
"path": "Claim.coverage.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "Claim.exception",
"short": "Eligibility exceptions",
"definition": "Factors which may influence the applicability of coverage.",
"requirements": "To determine extenuating circumstances for coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Exception",
"strength": "example",
"description": "The eligibility exception codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/exception"
}
}
},
{
"path": "Claim.school",
"short": "Name of School",
"definition": "Name of school for over-aged dependants.",
"requirements": "Often required for over-age dependents.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Claim.accident",
"short": "Accident Date",
"definition": "Date of an accident which these services are addressing.",
"requirements": "Coverage may be dependant on accidents.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.accidentType",
"short": "Accident Type",
"definition": "Type of accident: work, auto, etc.",
"requirements": "Coverage may be dependant on the type of accident.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AccidentType",
"strength": "example",
"description": "Type of accident: work place, auto, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActIncidentCode"
}
}
},
{
"path": "Claim.interventionException",
"short": "Intervention and exception code (Pharma)",
"definition": "A list of intervention and exception codes which may influence the adjudication of the claim.",
"requirements": "Coverage may be modified based on exception information provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Intervention",
"strength": "example",
"description": "Intervention and exception codes (Pharm)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/intervention"
}
}
},
{
"path": "Claim.item",
"short": "Goods and Services",
"definition": "First tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.type",
"short": "Group or type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Claim.item.diagnosisLinkId",
"short": "Diagnosis Link",
"definition": "Diagnosis applicable for this service or product line.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.service",
"short": "Item Code",
"definition": "If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.serviceDate",
"short": "Date of Service",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.item.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.net",
"short": "Total item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.bodySite",
"short": "Service Location",
"definition": "Physical service site on the patient (limb, tooth, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "OralSites",
"strength": "example",
"description": "The code for the teeth, quadrant, sextant and arch",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/tooth"
}
}
},
{
"path": "Claim.item.subSite",
"short": "Service Sub-location",
"definition": "A region or surface of the site, eg. limb region or tooth surface(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Surface",
"strength": "example",
"description": "The code for the tooth surface and surface combinations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/surface"
}
}
},
{
"path": "Claim.item.modifier",
"short": "Service/Product billing modifiers",
"definition": "Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Modifiers",
"strength": "example",
"description": "Item type or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or an appliance was lost or stolen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modifiers"
}
}
},
{
"path": "Claim.item.detail",
"short": "Additional items",
"definition": "Second tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.detail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.detail.type",
"short": "Group or type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.detail.service",
"short": "Additional item codes",
"definition": "If a grouping item then 'GROUP' otherwise it is a node therefore a code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.detail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.detail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.net",
"short": "Total additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.detail.subDetail",
"short": "Additional items",
"definition": "Third tier of goods and services.",
"min": 0,
"max": "*"
},
{
"path": "Claim.item.detail.subDetail.sequence",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Claim.item.detail.subDetail.type",
"short": "Type of product or service",
"definition": "The type of product or service.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ItemType",
"strength": "example",
"description": "Service, Product, Rx Dispense, Rx Compound etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ActInvoiceGroupCode"
}
}
},
{
"path": "Claim.item.detail.subDetail.service",
"short": "Additional item codes",
"definition": "The fee for an addittional service or product or charge.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "Claim.item.detail.subDetail.quantity",
"short": "Count of Products or Services",
"definition": "The number of repetitions of a service or product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "Claim.item.detail.subDetail.unitPrice",
"short": "Fee, charge or cost per point",
"definition": "The fee for an addittional service or product or charge.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.subDetail.factor",
"short": "Price scaling factor",
"definition": "A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.subDetail.points",
"short": "Difficulty scaling factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the good or service delivered. The concept of Points allows for assignment of point values for services and/or goods, such that a monetary amount can be assigned to each point.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "Claim.item.detail.subDetail.net",
"short": "Net additional item cost",
"definition": "The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"requirements": "If a fee is present the associated product/service code must be present.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Claim.item.detail.subDetail.udi",
"short": "Unique Device Identifier",
"definition": "List of Unique Device Identifiers associated with this line item.",
"requirements": "The UDI code and issuer if applicable for the supplied product.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "UDI",
"strength": "example",
"description": "The FDA, or other, UDI repository.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/udi"
}
}
},
{
"path": "Claim.item.prosthesis",
"short": "Prosthetic details",
"definition": "The materials and placement date of prior fixed prosthesis.",
"min": 0,
"max": "1"
},
{
"path": "Claim.item.prosthesis.initial",
"short": "Is this the initial service",
"definition": "Indicates whether this is the initial placement of a fixed prosthesis.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Claim.item.prosthesis.priorDate",
"short": "Initial service Date",
"definition": "Date of the initial placement.",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "Claim.item.prosthesis.priorMaterial",
"short": "Prosthetic Material",
"definition": "Material of the prior denture or bridge prosthesis. (Oral).",
"requirements": "May impact on adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "OralProsthoMaterial",
"strength": "example",
"description": "Material of the prior denture or bridge prosthesis. (Oral)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/oral-prosthodontic-material"
}
}
},
{
"path": "Claim.additionalMaterials",
"short": "Additional materials, documents, etc.",
"definition": "Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdditionalMaterials",
"strength": "example",
"description": "Code to indicate that Xrays, images, emails, documents, models or attachments are being sent in support of this submission.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/additionalmaterials"
}
}
},
{
"path": "Claim.missingTeeth",
"short": "Only if type = oral",
"definition": "A list of teeth which would be expected but are not found due to having been previously extracted or for other reasons.",
"requirements": "The list of missing teeth may influence the adjudication of services for example with Bridges.",
"min": 0,
"max": "*"
},
{
"path": "Claim.missingTeeth.tooth",
"short": "Tooth Code",
"definition": "The code identifying which tooth is missing.",
"requirements": "Provides the tooth number of the missing tooth.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Tooth",
"strength": "example",
"description": "The codes for the teeth, subset of OralSites",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/teeth"
}
}
},
{
"path": "Claim.missingTeeth.reason",
"short": "Reason for missing",
"definition": "Missing reason may be: E-extraction, O-other.",
"requirements": "Provides the reason for the missing tooth.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MissingReason",
"strength": "example",
"description": "Reason codes for the missing teeth",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/missing-tooth-reason"
}
}
},
{
"path": "Claim.missingTeeth.extractionDate",
"short": "Date of Extraction",
"definition": "The date of the extraction either known from records or patient reported estimate.",
"requirements": "Some services and adjudications require this information.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ClaimResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ClaimResponse",
"name": "ClaimResponse",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ClaimResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ClaimResponse",
"short": "Remittance resource",
"definition": "This resource provides the adjudication details from the processing of a Claim resource.",
"alias": [
"Remittance Advice"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ClaimResponse"
}
]
},
{
"path": "ClaimResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ClaimResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ClaimResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ClaimResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ClaimResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ClaimResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.identifier",
"short": "Response number",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.request",
"short": "Id of resource triggering adjudication",
"definition": "Original request resource referrence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ClaimResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClaimResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ClaimResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ClaimResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ClaimResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ClaimResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.payeeType",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "ClaimResponse.item",
"short": "Line items",
"definition": "The first tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.noteNumber",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.item.adjudication",
"short": "Adjudication details",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.adjudication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.adjudication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail",
"short": "Detail line items",
"definition": "The second tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication",
"short": "Detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail",
"short": "Subdetail line items",
"definition": "The third tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subDetail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication",
"short": "Subdetail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.addItem",
"short": "Insurer added line items",
"definition": "The first tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.addItem.sequenceLinkId",
"short": "Service instances",
"definition": "List of input service items which this service line is intended to replace.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.addItem.service",
"short": "Group, Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.addItem.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.noteNumberLinkId",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication",
"short": "Added items adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.addItem.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.addItem.detail",
"short": "Added items details",
"definition": "The second tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.addItem.detail.service",
"short": "Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.addItem.detail.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication",
"short": "Added items detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.detail.adjudication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.addItem.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.error.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.error.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.error.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.error.sequenceLinkId",
"short": "Item sequence number",
"definition": "The sequence number of the line item submitted which contains the error. This value is ommitted when the error is elsewhere.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.detailSequenceLinkId",
"short": "Detail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.subdetailSequenceLinkId",
"short": "Subdetail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.code",
"short": "Error code detailing processing issues",
"definition": "An error code,froma specified code system, which details why the claim could not be adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"strength": "required",
"description": "The error codes for adjudication processing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
},
{
"path": "ClaimResponse.totalCost",
"short": "Total Cost of service from the Claim",
"definition": "The total cost of the services reported.",
"requirements": "This is a check value that the receiver calculates and returns.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.unallocDeductable",
"short": "Unallocated deductable",
"definition": "The amount of deductable applied which was not allocated to any particular service line.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.totalBenefit",
"short": "Total benefit payable for the Claim",
"definition": "Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustment",
"short": "Payment adjustment for non-Claim issues",
"definition": "Adjustment to the payment of this transaction which is not related to adjudication of this transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustmentReason",
"short": "Reason for Payment adjustment",
"definition": "Reason for the payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjustmentReason",
"strength": "required",
"description": "Adjustment reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjustment-reason"
}
}
},
{
"path": "ClaimResponse.paymentDate",
"short": "Expected data of Payment",
"definition": "Estimated payment data.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "ClaimResponse.paymentAmount",
"short": "Payment amount",
"definition": "Payable less any payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentRef",
"short": "Payment identifier",
"definition": "Payment identifer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.reserved",
"short": "Funds reserved status",
"definition": "Status of funds reservation (For provider, for Patient, None).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "ClaimResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ClaimResponse.note",
"short": "Processing notes",
"definition": "Note text.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.note.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.note.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.note.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.note.number",
"short": "Note Number for this note",
"definition": "An integer associated with each note which may be referred to from each service line item.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ClaimResponse.note.text",
"short": "Note explanitory text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
},
{
"path": "ClaimResponse.coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "ClaimResponse.coverage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.coverage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClaimResponse.coverage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClaimResponse.coverage.sequence",
"short": "Service instance identifier",
"definition": "A service line item.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.coverage.focal",
"short": "Is the focal Coverage",
"definition": "The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ClaimResponse.coverage.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "ClaimResponse.coverage.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.coverage.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "C03"
}
]
},
{
"path": "ClaimResponse.coverage.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F03"
}
]
},
{
"path": "ClaimResponse.coverage.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "EOB"
}
]
},
{
"path": "ClaimResponse.coverage.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
}
]
},
"differential": {
"element": [
{
"path": "ClaimResponse",
"short": "Remittance resource",
"definition": "This resource provides the adjudication details from the processing of a Claim resource.",
"alias": [
"Remittance Advice"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ClaimResponse.identifier",
"short": "Response number",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.request",
"short": "Id of resource triggering adjudication",
"definition": "Original request resource referrence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ClaimResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ClaimResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClaimResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ClaimResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ClaimResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ClaimResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ClaimResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.payeeType",
"short": "Party to be paid any benefits payable",
"definition": "Party to be reimbursed: Subscriber, provider, other.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PayeeType",
"strength": "example",
"description": "A code for the party to be reimbursed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payeetype"
}
}
},
{
"path": "ClaimResponse.item",
"short": "Line items",
"definition": "The first tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.noteNumber",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.item.adjudication",
"short": "Adjudication details",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail",
"short": "Detail line items",
"definition": "The second tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication",
"short": "Detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail",
"short": "Subdetail line items",
"definition": "The third tier service adjudications for submitted services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subDetail.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F07"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication",
"short": "Subdetail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.item.detail.subDetail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.addItem",
"short": "Insurer added line items",
"definition": "The first tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.sequenceLinkId",
"short": "Service instances",
"definition": "List of input service items which this service line is intended to replace.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.addItem.service",
"short": "Group, Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.addItem.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.noteNumberLinkId",
"short": "List of note numbers which apply",
"definition": "A list of note references to the notes provided below.",
"min": 0,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication",
"short": "Added items adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.addItem.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.addItem.detail",
"short": "Added items details",
"definition": "The second tier service adjudications for payor added services.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.detail.service",
"short": "Service or Product",
"definition": "A code to indicate the Professional Service or Product supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ServiceProduct",
"strength": "example",
"description": "Allowable service and product codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-uscls"
}
}
},
{
"path": "ClaimResponse.addItem.detail.fee",
"short": "Professional fee or Product charge",
"definition": "The fee charged for the professional service or product..",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication",
"short": "Added items detail adjudication",
"definition": "The adjudications results.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.addItem.detail.adjudication.code",
"short": "Adjudication category such as co-pay, eligible, benefit, etc.",
"definition": "Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Adjudication",
"strength": "required",
"description": "The adjudication codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication"
}
}
},
{
"path": "ClaimResponse.addItem.detail.adjudication.amount",
"short": "Monitary amount",
"definition": "Monitory amount associated with the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.addItem.detail.adjudication.value",
"short": "Non-monitory value",
"definition": "A non-monitary value for example a percentage. Mutually exclusive to the amount element above.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "ClaimResponse.error",
"short": "Processing errors",
"definition": "Mutually exclusive with Services Provided (Item).",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.error.sequenceLinkId",
"short": "Item sequence number",
"definition": "The sequence number of the line item submitted which contains the error. This value is ommitted when the error is elsewhere.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.detailSequenceLinkId",
"short": "Detail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.subdetailSequenceLinkId",
"short": "Subdetail sequence number",
"definition": "The sequence number of the addition within the line item submitted which contains the error. This value is ommitted when the error is not related to an Addition.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.error.code",
"short": "Error code detailing processing issues",
"definition": "An error code,froma specified code system, which details why the claim could not be adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"strength": "required",
"description": "The error codes for adjudication processing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
},
{
"path": "ClaimResponse.totalCost",
"short": "Total Cost of service from the Claim",
"definition": "The total cost of the services reported.",
"requirements": "This is a check value that the receiver calculates and returns.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.unallocDeductable",
"short": "Unallocated deductable",
"definition": "The amount of deductable applied which was not allocated to any particular service line.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.totalBenefit",
"short": "Total benefit payable for the Claim",
"definition": "Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustment",
"short": "Payment adjustment for non-Claim issues",
"definition": "Adjustment to the payment of this transaction which is not related to adjudication of this transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentAdjustmentReason",
"short": "Reason for Payment adjustment",
"definition": "Reason for the payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjustmentReason",
"strength": "required",
"description": "Adjustment reason codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjustment-reason"
}
}
},
{
"path": "ClaimResponse.paymentDate",
"short": "Expected data of Payment",
"definition": "Estimated payment data.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "ClaimResponse.paymentAmount",
"short": "Payment amount",
"definition": "Payable less any payment adjustment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "ClaimResponse.paymentRef",
"short": "Payment identifier",
"definition": "Payment identifer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ClaimResponse.reserved",
"short": "Funds reserved status",
"definition": "Status of funds reservation (For provider, for Patient, None).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "FundsReserve",
"strength": "example",
"description": "For whom funds are to be reserved: (Patient, Provider, None)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/fundsreserve"
}
}
},
{
"path": "ClaimResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ClaimResponse.note",
"short": "Processing notes",
"definition": "Note text.",
"min": 0,
"max": "*"
},
{
"path": "ClaimResponse.note.number",
"short": "Note Number for this note",
"definition": "An integer associated with each note which may be referred to from each service line item.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ClaimResponse.note.text",
"short": "Note explanitory text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
},
{
"path": "ClaimResponse.coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument by which payment information for health care.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "ClaimResponse.coverage.sequence",
"short": "Service instance identifier",
"definition": "A service line item.",
"requirements": "To maintain order of the coverages.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ClaimResponse.coverage.focal",
"short": "Is the focal Coverage",
"definition": "The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.",
"requirements": "To identify which coverage is being adjudicated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ClaimResponse.coverage.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "ClaimResponse.coverage.businessArrangement",
"short": "Business agreement",
"definition": "The contract number of a business agreement which describes the terms and conditions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClaimResponse.coverage.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "C03"
}
]
},
{
"path": "ClaimResponse.coverage.preAuthRef",
"short": "Pre-Authorization/Determination Reference",
"definition": "A list of references from the Insurer to which these services pertain.",
"requirements": "To provide any pre=determination or prior authorization reference.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "F03"
}
]
},
{
"path": "ClaimResponse.coverage.claimResponse",
"short": "Adjudication results",
"definition": "The Coverages adjudication details.",
"requirements": "Used by downstream payers to determine what balance remains and the net payable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClaimResponse"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "EOB"
}
]
},
{
"path": "ClaimResponse.coverage.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ClinicalImpression",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ClinicalImpression",
"name": "ClinicalImpression",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ClinicalImpression Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ClinicalImpression",
"short": "A clinical assessment performed when planning treatments and management strategies for a patient",
"definition": "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.",
"min": 1,
"max": "1",
"type": [
{
"code": "ClinicalImpression"
}
]
},
{
"path": "ClinicalImpression.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ClinicalImpression.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ClinicalImpression.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ClinicalImpression.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ClinicalImpression.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ClinicalImpression.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.patient",
"short": "The patient being asssesed",
"definition": "The patient being asssesed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "ClinicalImpression.assessor",
"short": "The clinician performing the assessment",
"definition": "The clinician performing the assessment.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "ClinicalImpression.date",
"short": "When the assessment occurred",
"definition": "The point in time at which the assessment was concluded (not when it was recorded).",
"comments": "This SHOULD be accurate to at least the minute, though some assessments only have a known date.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClinicalImpression.description",
"short": "Why/how the assessment was performed",
"definition": "A summary of the context and/or cause of the assessment - why / where was it peformed, and what patient events/sstatus prompted it.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.previous",
"short": "Reference to last assessment",
"definition": "A reference to the last assesment that was conducted bon this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.",
"comments": "It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClinicalImpression"
}
]
},
{
"path": "ClinicalImpression.problem",
"short": "General assessment of patient state",
"definition": "This a list of the general problems/conditions for a patient.",
"comments": "e.g. The patient is a pregnant, and cardiac congestive failure, Adenocarcinoma, and is allergic to penicillin.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
]
},
{
"path": "ClinicalImpression.trigger[x]",
"short": "Request or event that necessitated this assessment",
"definition": "The request or event that necessitated this assessment. This may be a diagnosis, a Care Plan, a Request Referral, or some other resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"binding": {
"name": "ClinicalFindings",
"strength": "example",
"description": "Clinical Findings that may cause an clinical evaluation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
}
},
{
"path": "ClinicalImpression.investigations",
"short": "One or more sets of investigations (signs, symptions, etc)",
"definition": "One or more sets of investigations (signs, symptions, etc). The actual grouping of investigations vary greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.investigations.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.investigations.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.investigations.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.investigations.code",
"short": "A name/code for the set",
"definition": "A name/code for the group (\"set\") of investigations. Typically, this will be something like \"signs\", \"symptoms\", \"clinical\", \"diagnostic\", but the list is not constrained, and others such groups such as (exposure|family|travel|nutitirional) history may be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "investigationGroupType",
"strength": "example",
"description": "A name/code for a set of investigations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/investigation-sets"
}
}
},
{
"path": "ClinicalImpression.investigations.item",
"short": "Record of a specific investigation",
"definition": "A record of a specific investigation that was undertaken.",
"comments": "Most investigations are observations of one kind of or another but some other specific types of data collection resources can also be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyHistory"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}
]
},
{
"path": "ClinicalImpression.protocol",
"short": "Clinical Protocol followed",
"definition": "Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ClinicalImpression.summary",
"short": "Summary of the assessment",
"definition": "A text summary of the investigations and the diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.finding",
"short": "Possible or likely findings and diagnoses",
"definition": "Specific findings or diagnoses that was considered likely or relevant to ongoing treatment.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.finding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.finding.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.finding.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.finding.item",
"short": "Specific text or code for finding",
"definition": "Specific text of code for finding or diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.finding.cause",
"short": "Which investigations support finding",
"definition": "Which investigations support finding or diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.resolved",
"short": "Diagnosies/conditions resolved since previous assessment",
"definition": "Diagnoses/conditions resolved since the last assessment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.ruledOut",
"short": "Diagnosis considered not possible",
"definition": "Diagnosis considered not possible.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.ruledOut.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.ruledOut.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ClinicalImpression.ruledOut.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ClinicalImpression.ruledOut.item",
"short": "Specific text of code for diagnosis",
"definition": "Specific text of code for diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.ruledOut.reason",
"short": "Grounds for elimination",
"definition": "Grounds for elimination.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.prognosis",
"short": "Estimate of likely outcome",
"definition": "Estimate of likely outcome.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.plan",
"short": "Plan of action after assessment",
"definition": "Plan of action after assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
]
},
{
"path": "ClinicalImpression.action",
"short": "Actions taken during assessment",
"definition": "Actions taken during assessment.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ClinicalImpression",
"short": "A clinical assessment performed when planning treatments and management strategies for a patient",
"definition": "A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called \"ClinicalImpression\" rather than \"ClinicalAssessment\" to avoid confusion with the recording of assessment tools such as Apgar score.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ClinicalImpression.patient",
"short": "The patient being asssesed",
"definition": "The patient being asssesed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "ClinicalImpression.assessor",
"short": "The clinician performing the assessment",
"definition": "The clinician performing the assessment.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "ClinicalImpression.date",
"short": "When the assessment occurred",
"definition": "The point in time at which the assessment was concluded (not when it was recorded).",
"comments": "This SHOULD be accurate to at least the minute, though some assessments only have a known date.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ClinicalImpression.description",
"short": "Why/how the assessment was performed",
"definition": "A summary of the context and/or cause of the assessment - why / where was it peformed, and what patient events/sstatus prompted it.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.previous",
"short": "Reference to last assessment",
"definition": "A reference to the last assesment that was conducted bon this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient's conditions changes.",
"comments": "It is always likely that multiple previous assessments exist for a patient. The point of quoting a previous assessment is that this assessment is relative to it (see resolved).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ClinicalImpression"
}
]
},
{
"path": "ClinicalImpression.problem",
"short": "General assessment of patient state",
"definition": "This a list of the general problems/conditions for a patient.",
"comments": "e.g. The patient is a pregnant, and cardiac congestive failure, Adenocarcinoma, and is allergic to penicillin.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
]
},
{
"path": "ClinicalImpression.trigger[x]",
"short": "Request or event that necessitated this assessment",
"definition": "The request or event that necessitated this assessment. This may be a diagnosis, a Care Plan, a Request Referral, or some other resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"binding": {
"name": "ClinicalFindings",
"strength": "example",
"description": "Clinical Findings that may cause an clinical evaluation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
}
},
{
"path": "ClinicalImpression.investigations",
"short": "One or more sets of investigations (signs, symptions, etc)",
"definition": "One or more sets of investigations (signs, symptions, etc). The actual grouping of investigations vary greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.investigations.code",
"short": "A name/code for the set",
"definition": "A name/code for the group (\"set\") of investigations. Typically, this will be something like \"signs\", \"symptoms\", \"clinical\", \"diagnostic\", but the list is not constrained, and others such groups such as (exposure|family|travel|nutitirional) history may be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "investigationGroupType",
"strength": "example",
"description": "A name/code for a set of investigations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/investigation-sets"
}
}
},
{
"path": "ClinicalImpression.investigations.item",
"short": "Record of a specific investigation",
"definition": "A record of a specific investigation that was undertaken.",
"comments": "Most investigations are observations of one kind of or another but some other specific types of data collection resources can also be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyHistory"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}
]
},
{
"path": "ClinicalImpression.protocol",
"short": "Clinical Protocol followed",
"definition": "Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ClinicalImpression.summary",
"short": "Summary of the assessment",
"definition": "A text summary of the investigations and the diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.finding",
"short": "Possible or likely findings and diagnoses",
"definition": "Specific findings or diagnoses that was considered likely or relevant to ongoing treatment.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.finding.item",
"short": "Specific text or code for finding",
"definition": "Specific text of code for finding or diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.finding.cause",
"short": "Which investigations support finding",
"definition": "Which investigations support finding or diagnosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.resolved",
"short": "Diagnosies/conditions resolved since previous assessment",
"definition": "Diagnoses/conditions resolved since the last assessment.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.ruledOut",
"short": "Diagnosis considered not possible",
"definition": "Diagnosis considered not possible.",
"min": 0,
"max": "*"
},
{
"path": "ClinicalImpression.ruledOut.item",
"short": "Specific text of code for diagnosis",
"definition": "Specific text of code for diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"path": "ClinicalImpression.ruledOut.reason",
"short": "Grounds for elimination",
"definition": "Grounds for elimination.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.prognosis",
"short": "Estimate of likely outcome",
"definition": "Estimate of likely outcome.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ClinicalImpression.plan",
"short": "Plan of action after assessment",
"definition": "Plan of action after assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
]
},
{
"path": "ClinicalImpression.action",
"short": "Actions taken during assessment",
"definition": "Actions taken during assessment.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Communication",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Communication",
"name": "Communication",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Communication Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"definition": "An occurrence of information being transmitted. E.g., an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "Communication"
}
]
},
{
"path": "Communication.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Communication.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Communication.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Communication.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Communication.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Communication.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Communication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Communication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Communication.identifier",
"short": "Unique identifier",
"definition": "Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Communication.category",
"short": "Message category",
"definition": "The type of message such as alert, notification, reminder, instruction, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.sender",
"short": "Message sender",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the source of the communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Communication.recipient",
"short": "Message recipient",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the target of the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Communication.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min": 0,
"max": "*"
},
{
"path": "Communication.payload.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Communication.payload.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Communication.payload.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Communication.payload.content[x]",
"short": "Message part content",
"definition": "An individual message part for multi-part messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "Communication.medium",
"short": "Communication medium",
"definition": "The communication medium, e.g., email, fax.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.status",
"short": "in-progress | completed | suspended | rejected | failed",
"definition": "The status of the transmission.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CommunicationStatus",
"strength": "required",
"description": "The status of the communication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/communication-status"
}
}
},
{
"path": "Communication.encounter",
"short": "Encounter leading to message",
"definition": "The encounter within which the communication was sent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
]
},
{
"path": "Communication.sent",
"short": "When sent",
"definition": "The time when this communication was sent.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Communication.received",
"short": "When received",
"definition": "The time when this communication arrived at the destination.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Communication.reason",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.subject",
"short": "Focus of message",
"definition": "The patient who is the focus of this communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Communication",
"short": "A record of information transmitted from a sender to a receiver",
"definition": "An occurrence of information being transmitted. E.g., an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "Communication.identifier",
"short": "Unique identifier",
"definition": "Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Communication.category",
"short": "Message category",
"definition": "The type of message such as alert, notification, reminder, instruction, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.sender",
"short": "Message sender",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the source of the communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Communication.recipient",
"short": "Message recipient",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the target of the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "Communication.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min": 0,
"max": "*"
},
{
"path": "Communication.payload.content[x]",
"short": "Message part content",
"definition": "An individual message part for multi-part messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "Communication.medium",
"short": "Communication medium",
"definition": "The communication medium, e.g., email, fax.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.status",
"short": "in-progress | completed | suspended | rejected | failed",
"definition": "The status of the transmission.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CommunicationStatus",
"strength": "required",
"description": "The status of the communication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/communication-status"
}
}
},
{
"path": "Communication.encounter",
"short": "Encounter leading to message",
"definition": "The encounter within which the communication was sent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
]
},
{
"path": "Communication.sent",
"short": "When sent",
"definition": "The time when this communication was sent.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Communication.received",
"short": "When received",
"definition": "The time when this communication arrived at the destination.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Communication.reason",
"short": "Indication for message",
"definition": "The reason or justification for the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "Communication.subject",
"short": "Focus of message",
"definition": "The patient who is the focus of this communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "CommunicationRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest",
"name": "CommunicationRequest",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for CommunicationRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "CommunicationRequest",
"short": "A request for information to be sent to a receiver",
"definition": "A request to convey information. E.g., the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CommunicationRequest"
}
]
},
{
"path": "CommunicationRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "CommunicationRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "CommunicationRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "CommunicationRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "CommunicationRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "CommunicationRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CommunicationRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CommunicationRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CommunicationRequest.identifier",
"short": "Unique identifier",
"definition": "A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be auto-generated, if needed, by CDS system. Does not need to be the actual ID of the source system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "CommunicationRequest.category",
"short": "Message category",
"definition": "The type of message such as alert, notification, reminder, instruction, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.sender",
"short": "Message sender",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the source of the communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "CommunicationRequest.recipient",
"short": "Message recipient",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the intended target of the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "CommunicationRequest.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min": 0,
"max": "*"
},
{
"path": "CommunicationRequest.payload.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CommunicationRequest.payload.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "CommunicationRequest.payload.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "CommunicationRequest.payload.content[x]",
"short": "Message part content",
"definition": "An individual message part for multi-part messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "CommunicationRequest.medium",
"short": "Communication medium",
"definition": "The communication medium, e.g., email, fax.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.requester",
"short": "Requester of communication",
"definition": "The responsible person who authorizes this order, e.g., physician. This may be different than the author of the order statement, e.g., clerk, who may have entered the statement into the order entry application.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "CommunicationRequest.status",
"short": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed",
"definition": "The status of the proposal or order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CommunicationRequestStatus",
"strength": "required",
"description": "The status of the communication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/communication-request-status"
}
}
},
{
"path": "CommunicationRequest.encounter",
"short": "Encounter leading to message",
"definition": "The encounter within which the communication request was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
]
},
{
"path": "CommunicationRequest.scheduledTime",
"short": "When scheduled",
"definition": "The time when this communication is to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "CommunicationRequest.reason",
"short": "Indication for message",
"definition": "The reason or justification for the communication request.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.orderedOn",
"short": "When ordered or proposed",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "CommunicationRequest.subject",
"short": "Focus of message",
"definition": "The patient who is the focus of this communication request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "CommunicationRequest.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
},
"differential": {
"element": [
{
"path": "CommunicationRequest",
"short": "A request for information to be sent to a receiver",
"definition": "A request to convey information. E.g., the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "CommunicationRequest.identifier",
"short": "Unique identifier",
"definition": "A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be auto-generated, if needed, by CDS system. Does not need to be the actual ID of the source system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "CommunicationRequest.category",
"short": "Message category",
"definition": "The type of message such as alert, notification, reminder, instruction, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.sender",
"short": "Message sender",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the source of the communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "CommunicationRequest.recipient",
"short": "Message recipient",
"definition": "The entity (e.g., person, organization, clinical information system, or device) which is the intended target of the communication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "CommunicationRequest.payload",
"short": "Message payload",
"definition": "Text, attachment(s), or resource(s) to be communicated to the recipient.",
"min": 0,
"max": "*"
},
{
"path": "CommunicationRequest.payload.content[x]",
"short": "Message part content",
"definition": "An individual message part for multi-part messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
},
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "CommunicationRequest.medium",
"short": "Communication medium",
"definition": "The communication medium, e.g., email, fax.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.requester",
"short": "Requester of communication",
"definition": "The responsible person who authorizes this order, e.g., physician. This may be different than the author of the order statement, e.g., clerk, who may have entered the statement into the order entry application.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "CommunicationRequest.status",
"short": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | failed",
"definition": "The status of the proposal or order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "CommunicationRequestStatus",
"strength": "required",
"description": "The status of the communication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/communication-request-status"
}
}
},
{
"path": "CommunicationRequest.encounter",
"short": "Encounter leading to message",
"definition": "The encounter within which the communication request was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
]
},
{
"path": "CommunicationRequest.scheduledTime",
"short": "When scheduled",
"definition": "The time when this communication is to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "CommunicationRequest.reason",
"short": "Indication for message",
"definition": "The reason or justification for the communication request.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "CommunicationRequest.orderedOn",
"short": "When ordered or proposed",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "CommunicationRequest.subject",
"short": "Focus of message",
"definition": "The patient who is the focus of this communication request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"path": "CommunicationRequest.priority",
"short": "Message urgency",
"definition": "Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Composition-document",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Composition-document",
"name": "Generate a Document",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "A client can ask a server to generate a fully bundled document from a composition resource.\nThe server takes the composition resource, locates all the referenced resources and other\nadditional resources as configured or requested and either returns a full document bundle,\nor returns an error. Note that since this is a search operation, the document bundle is \nwrapped inside the search bundle.\n\nIf some of the resources are located on other servers, it is at the discretion of the \nserver whether to retrieve them or return an error. If the correct version of the document \nthat would be generated already exists, then the server can return the existing one.",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "document",
"system": false,
"type": [
"Composition"
],
"instance": false,
"parameter": [
{
"name": "persist",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Whether to store the document at the document end-point (/Document) or not once it is generated. Value = true or false (default is for the server to decide)",
"type": "boolean"
},
{
"name": "cert",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Certificate URL to use to sign the document with. The certificate should be associated with one of the attestors",
"type": "string"
},
{
"name": "pword",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Password for private key if certificate requires one and the server doesn't know it by some other means. Putting the password in the URL has obvious security implications to consider. An alternative is for the client to sign the document",
"type": "string"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Composition",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Composition",
"name": "Composition",
"publisher": "HL7 FHIR Project (Structured Documents)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Composition Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Composition",
"short": "A set of resources composed into a single coherent clinical statement with clinical attestation",
"definition": "A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.",
"comments": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"requirements": "To support documents, and also to capture the EN13606 notion of an attested commit to the patient EHR, and to allow a set of disparate resources at the information/engineering level to be gathered into a clinical statement.",
"min": 1,
"max": "1",
"type": [
{
"code": "Composition"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument"
},
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]"
}
]
},
{
"path": "Composition.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Composition.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Composition.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Composition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Composition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Composition.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.identifier",
"short": "Logical identifier of composition (version-independent)",
"definition": "Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.",
"comments": "See discussion in resource definition for how these relate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".setId"
},
{
"identity": "rim",
"map": "Document.id / Document.setId"
}
]
},
{
"path": "Composition.date",
"short": "Composition editing time",
"definition": "The composition editing time, when the composition was last logically changed by the author.",
"comments": "The Last Modified Date on the composition may be after the date of the document was attested without being changed.",
"requirements": "dateTime is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".effectiveTime"
},
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
}
]
},
{
"path": "Composition.type",
"short": "Kind of composition (LOINC if possible)",
"definition": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"requirements": "Key metadata element describing the composition, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentType",
"strength": "required",
"description": "Type of a composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/doc-typecodes"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Composition.class",
"short": "Categorization of Composition",
"definition": "A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.",
"requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80Class",
"strength": "preferred",
"description": "High-level classification of a clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-classcodes"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Composition.title",
"short": "Human Readable name/title",
"definition": "Official human-readable label for the composition.",
"comments": "If compositions do not have a title, the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\") can be used in its place.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".title"
},
{
"identity": "rim",
"map": "./title"
}
]
},
{
"path": "Composition.status",
"short": "preliminary | final | appended | amended | entered-in-error",
"definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"comments": "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"withdrawn\" is why this element is labeled as a modifier of other elements.",
"requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "CompositionStatus",
"strength": "required",
"description": "The workflow/clinical status of the composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
}
]
},
{
"path": "Composition.confidentiality",
"short": "As defined by affinity domain",
"definition": "The code specifying the level of confidentiality of the Composition.",
"comments": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DocumentConfidentiality",
"strength": "required",
"description": "Codes specifying the level of confidentiality of the composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "cda",
"map": ".confidentialityCode"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "Composition.subject",
"short": "Who and/or what the composition is about",
"definition": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).",
"comments": "For clinical documents, this is usually the patient.",
"requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".recordTarget"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
}
]
},
{
"path": "Composition.author",
"short": "Who and/or what authored the composition",
"definition": "Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).",
"requirements": "Identifies who is responsible for the content.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".author.assignedAuthor"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "Composition.attester",
"short": "Attests to accuracy of composition",
"definition": "A participant who has attested to the accuracy of the composition/document.",
"comments": "Only list each attester once.",
"requirements": "Identifies responsibility for the accuracy of the composition content.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator/.legalAuthenticator"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "Composition.attester.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.attester.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.attester.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.attester.mode",
"short": "personal | professional | legal | official",
"definition": "The type of attestation the authenticator offers.",
"comments": "Use more than one code where a single attester has more than one mode (professional and legal are often paired).",
"requirements": "Indicates the level of officialness of the attestation.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "CompositionAttestationMode",
"strength": "required",
"description": "The way in which a person authenticated a composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-attestation-mode"
}
},
"mapping": [
{
"identity": "cda",
"map": "implied by .authenticator/.legalAuthenticator"
},
{
"identity": "rim",
"map": "unique(./modeCode)"
}
]
},
{
"path": "Composition.attester.time",
"short": "When composition attested",
"definition": "When composition was attested by the party.",
"requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator.time"
},
{
"identity": "rim",
"map": "./time[type=\"TS\" and isNormalDatatype()]"
}
]
},
{
"path": "Composition.attester.party",
"short": "Who attested the composition",
"definition": "Who attested the composition in the specified way.",
"requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator.assignedEnttty"
},
{
"identity": "rim",
"map": "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()]\nor\n./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]"
}
]
},
{
"path": "Composition.custodian",
"short": "Org which maintains the composition",
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"comments": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because knowing this is sometimes not known by the authoring system, and can be inferred by context. However it's important that this information be known when working with a derived document, so providing a custodian is encouraged.",
"requirements": "Identifies where to go to find the current version, where to report issues, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".custodian.assignedCustodian"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
},
{
"path": "Composition.event",
"short": "The clinical service(s) being documented",
"definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.",
"comments": "The event needs to be consistent with the type element, though can provide further information if desired.",
"requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".documentationOf.serviceEvent"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
},
{
"path": "Composition.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.event.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.event.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.event.code",
"short": "Code(s) that apply to the event being documented",
"definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as ???key words??? for certain types of queries.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentEventType",
"strength": "required",
"description": "This list of codes represents the main clinical acts being documented",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCode"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Composition.event.period",
"short": "The period covered by the documentation",
"definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".effectiveTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Composition.event.detail",
"short": "Full details for the event(s) the composition consents",
"definition": "Full details for the event(s) the composition/documentation consents.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target"
}
]
},
{
"path": "Composition.encounter",
"short": "Context of the conposition",
"definition": "Describes the clinical encounter or type of care this documentation is associated with.",
"requirements": "Provides context for the composition and supports searching.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".componentOf.encompassingEncounter"
},
{
"identity": "rim",
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
}
]
},
{
"path": "Composition.section",
"name": "section",
"short": "Composition is broken into sections",
"definition": "The root of the sections that make up the composition.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmp-1",
"name": "Section Content",
"severity": "error",
"human": "A section must have either subsections or content",
"xpath": "(exists(f:content) and not(exists(f:section))) or (exists(f:section) and not(exists(f:content)))"
}
],
"mapping": [
{
"identity": "cda",
"map": ".component.structuredBody.component.section"
},
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
]
},
{
"path": "Composition.section.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.section.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Composition.section.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Composition.section.title",
"short": "Label for section (e.g. for ToC)",
"definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.",
"comments": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference.",
"requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.",
"alias": [
"header",
"label",
"caption"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cda",
"map": ".title"
},
{
"identity": "rim",
"map": "./title"
}
]
},
{
"path": "Composition.section.code",
"short": "Classification of section (recommended)",
"definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.",
"comments": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.",
"requirements": "Provides computable standardized labels to topics within the document.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CompositionSectionType",
"strength": "required",
"description": "Classification of a section of a composition / document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/doc-section-codes"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Composition.section.content",
"short": "The Content of the section (narrative + data entries)",
"definition": "The content (narrative and data entries) associated with the section.",
"comments": "Because composition represent point-in-time snapshots, resource references should either be to a specific version, or made against resources on the same server with full version tracking, so that the correct versions can easily be assembled.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/List"
}
],
"condition": [
"cmp-1"
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "unique(./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode!=\"DOCSECT\" and isNormalAct])"
}
]
},
{
"path": "Composition.section.section",
"short": "Nested Section",
"definition": "A nested sub-section within this section.",
"comments": "Nested sections are primarily used to help human readers navigate to particular portions of the document.",
"min": 0,
"max": "*",
"nameReference": "section",
"condition": [
"cmp-1"
],
"mapping": [
{
"identity": "cda",
"map": ".component.section"
},
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Composition",
"short": "A set of resources composed into a single coherent clinical statement with clinical attestation",
"definition": "A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement.",
"comments": "While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.",
"requirements": "To support documents, and also to capture the EN13606 notion of an attested commit to the patient EHR, and to allow a set of disparate resources at the information/engineering level to be gathered into a clinical statement.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument"
},
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]"
}
]
},
{
"path": "Composition.identifier",
"short": "Logical identifier of composition (version-independent)",
"definition": "Logical Identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.",
"comments": "See discussion in resource definition for how these relate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".setId"
},
{
"identity": "rim",
"map": "Document.id / Document.setId"
}
]
},
{
"path": "Composition.date",
"short": "Composition editing time",
"definition": "The composition editing time, when the composition was last logically changed by the author.",
"comments": "The Last Modified Date on the composition may be after the date of the document was attested without being changed.",
"requirements": "dateTime is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".effectiveTime"
},
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
}
]
},
{
"path": "Composition.type",
"short": "Kind of composition (LOINC if possible)",
"definition": "Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.",
"requirements": "Key metadata element describing the composition, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentType",
"strength": "required",
"description": "Type of a composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/doc-typecodes"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Composition.class",
"short": "Categorization of Composition",
"definition": "A categorization for the type of the composition. This may be implied by or derived from the code specified in the Composition Type.",
"requirements": "Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80Class",
"strength": "preferred",
"description": "High-level classification of a clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-classcodes"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Composition.title",
"short": "Human Readable name/title",
"definition": "Official human-readable label for the composition.",
"comments": "If compositions do not have a title, the text or a display name of Composition.type (e.g. a \"consultation\" or \"progress note\") can be used in its place.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".title"
},
{
"identity": "rim",
"map": "./title"
}
]
},
{
"path": "Composition.status",
"short": "preliminary | final | appended | amended | entered-in-error",
"definition": "The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.",
"comments": "If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"withdrawn\" is why this element is labeled as a modifier of other elements.",
"requirements": "Need to be able to mark interim, amended, or withdrawn compositions or documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "CompositionStatus",
"strength": "required",
"description": "The workflow/clinical status of the composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseComposition\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
}
]
},
{
"path": "Composition.confidentiality",
"short": "As defined by affinity domain",
"definition": "The code specifying the level of confidentiality of the Composition.",
"comments": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DocumentConfidentiality",
"strength": "required",
"description": "Codes specifying the level of confidentiality of the composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/Confidentiality"
}
},
"mapping": [
{
"identity": "cda",
"map": ".confidentialityCode"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "Composition.subject",
"short": "Who and/or what the composition is about",
"definition": "Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).",
"comments": "For clinical documents, this is usually the patient.",
"requirements": "Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".recordTarget"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
}
]
},
{
"path": "Composition.author",
"short": "Who and/or what authored the composition",
"definition": "Identifies who is responsible for the information in the composition. (Not necessarily who typed it in.).",
"requirements": "Identifies who is responsible for the content.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".author.assignedAuthor"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "Composition.attester",
"short": "Attests to accuracy of composition",
"definition": "A participant who has attested to the accuracy of the composition/document.",
"comments": "Only list each attester once.",
"requirements": "Identifies responsibility for the accuracy of the composition content.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator/.legalAuthenticator"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "Composition.attester.mode",
"short": "personal | professional | legal | official",
"definition": "The type of attestation the authenticator offers.",
"comments": "Use more than one code where a single attester has more than one mode (professional and legal are often paired).",
"requirements": "Indicates the level of officialness of the attestation.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "CompositionAttestationMode",
"strength": "required",
"description": "The way in which a person authenticated a composition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-attestation-mode"
}
},
"mapping": [
{
"identity": "cda",
"map": "implied by .authenticator/.legalAuthenticator"
},
{
"identity": "rim",
"map": "unique(./modeCode)"
}
]
},
{
"path": "Composition.attester.time",
"short": "When composition attested",
"definition": "When composition was attested by the party.",
"requirements": "Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator.time"
},
{
"identity": "rim",
"map": "./time[type=\"TS\" and isNormalDatatype()]"
}
]
},
{
"path": "Composition.attester.party",
"short": "Who attested the composition",
"definition": "Who attested the composition in the specified way.",
"requirements": "Identifies who has taken on the responsibility for accuracy of the composition content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".authenticator.assignedEnttty"
},
{
"identity": "rim",
"map": "./role[classCode=\"ASSIGNED\" and isNormalRole]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"PSN\") and isNormalEntity()]\nor\n./role[classCode=\"ASSIGNED\" and isNormalRole and not(player)]/scoper[determinerCode=\"INST\" and classCode=\"ORG\" and isNormalEntity()]"
}
]
},
{
"path": "Composition.custodian",
"short": "Org which maintains the composition",
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.",
"comments": "This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because knowing this is sometimes not known by the authoring system, and can be inferred by context. However it's important that this information be known when working with a derived document, so providing a custodian is encouraged.",
"requirements": "Identifies where to go to find the current version, where to report issues, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".custodian.assignedCustodian"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
},
{
"path": "Composition.event",
"short": "The clinical service(s) being documented",
"definition": "The clinical service, such as a colonoscopy or an appendectomy, being documented.",
"comments": "The event needs to be consistent with the type element, though can provide further information if desired.",
"requirements": "Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".documentationOf.serviceEvent"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
},
{
"path": "Composition.event.code",
"short": "Code(s) that apply to the event being documented",
"definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the typeCode, such as where it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as ???key words??? for certain types of queries.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentEventType",
"strength": "required",
"description": "This list of codes represents the main clinical acts being documented",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCode"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Composition.event.period",
"short": "The period covered by the documentation",
"definition": "The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".effectiveTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Composition.event.detail",
"short": "Full details for the event(s) the composition consents",
"definition": "Full details for the event(s) the composition/documentation consents.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target"
}
]
},
{
"path": "Composition.encounter",
"short": "Context of the conposition",
"definition": "Describes the clinical encounter or type of care this documentation is associated with.",
"requirements": "Provides context for the composition and supports searching.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".componentOf.encompassingEncounter"
},
{
"identity": "rim",
"map": "unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
}
]
},
{
"path": "Composition.section",
"name": "section",
"short": "Composition is broken into sections",
"definition": "The root of the sections that make up the composition.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmp-1",
"name": "Section Content",
"severity": "error",
"human": "A section must have either subsections or content",
"xpath": "(exists(f:content) and not(exists(f:section))) or (exists(f:section) and not(exists(f:content)))"
}
],
"mapping": [
{
"identity": "cda",
"map": ".component.structuredBody.component.section"
},
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
]
},
{
"path": "Composition.section.title",
"short": "Label for section (e.g. for ToC)",
"definition": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.",
"comments": "The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference.",
"requirements": "Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.",
"alias": [
"header",
"label",
"caption"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cda",
"map": ".title"
},
{
"identity": "rim",
"map": "./title"
}
]
},
{
"path": "Composition.section.code",
"short": "Classification of section (recommended)",
"definition": "A code identifying the kind of content contained within the section. This must be consistent with the section title.",
"comments": "The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. \n\nIf the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.",
"requirements": "Provides computable standardized labels to topics within the document.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "CompositionSectionType",
"strength": "required",
"description": "Classification of a section of a composition / document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/doc-section-codes"
}
},
"mapping": [
{
"identity": "cda",
"map": ".code"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Composition.section.content",
"short": "The Content of the section (narrative + data entries)",
"definition": "The content (narrative and data entries) associated with the section.",
"comments": "Because composition represent point-in-time snapshots, resource references should either be to a specific version, or made against resources on the same server with full version tracking, so that the correct versions can easily be assembled.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/List"
}
],
"condition": [
"cmp-1"
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "unique(./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode!=\"DOCSECT\" and isNormalAct])"
}
]
},
{
"path": "Composition.section.section",
"short": "Nested Section",
"definition": "A nested sub-section within this section.",
"comments": "Nested sections are primarily used to help human readers navigate to particular portions of the document.",
"min": 0,
"max": "*",
"nameReference": "section",
"condition": [
"cmp-1"
],
"mapping": [
{
"identity": "cda",
"map": ".component.section"
},
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ConceptMap-translate",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
"name": "Concept Translation",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server. || One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated. || The outcome is an operationOutcome with hints, warnings, or errors, or the translated code in an extension",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "translate",
"system": false,
"type": [
"ConceptMap"
],
"instance": true,
"parameter": [
{
"name": "code",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The code that is to be translated. If a code is provided, a system must be provided",
"type": "code"
},
{
"name": "system",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The system for the code that is to be translated",
"type": "uri"
},
{
"name": "version",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The version of the system, if one was provided in the source data",
"type": "string"
},
{
"name": "valueSet",
"use": "in",
"min": 0,
"max": "1",
"documentation": "Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location",
"type": "uri"
},
{
"name": "coding",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A coding to translate",
"type": "Coding"
},
{
"name": "codeableConcept",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A full codeableConcept to validate. The server can translate any of the coding values as it chooses",
"type": "CodeableConcept"
},
{
"name": "target",
"use": "in",
"min": 1,
"max": "1",
"documentation": "Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location",
"type": "uri"
},
{
"name": "result",
"use": "out",
"min": 1,
"max": "1",
"documentation": "True if the concept could be translated",
"type": "boolean"
},
{
"name": "message",
"use": "out",
"min": 0,
"max": "1",
"documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings",
"type": "string"
},
{
"name": "equivalence",
"use": "out",
"min": 0,
"max": "1",
"documentation": "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-equivalence.html}",
"type": "code"
},
{
"name": "outcome",
"use": "out",
"min": 0,
"max": "1",
"documentation": "The translation outcome",
"type": "Coding"
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ConceptMap-batch",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ConceptMap-batch",
"name": "Batch Mode Translation",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Translate a set of concepts from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "batch",
"system": false,
"type": [
"ConceptMap"
],
"instance": false,
"parameter": [
{
"name": "item",
"use": "in",
"min": 0,
"max": "*",
"documentation": "An item to be translated",
"part": [
{
"name": "concept",
"min": 1,
"max": "1",
"documentation": "A codeable concept to be translated. If the source is a coding, or a code/system pair, wrap it in a CodeableConcept",
"type": "CodeableConcept"
},
{
"name": "target",
"min": 1,
"max": "*",
"documentation": "Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If more than one is provided, multiple translations are requested for the concept",
"type": "uri"
},
{
"name": "map",
"min": 0,
"max": "1",
"documentation": "A specific concept map to use for the translation. If none is provided, the server chooses which concept map to use",
"type": "Reference(ConceptMap)"
}
]
},
{
"name": "item",
"use": "out",
"min": 0,
"max": "*",
"documentation": "The outcome of validating an item. There must be an entry for every item in the same order",
"part": [
{
"name": "result",
"min": 1,
"max": "1",
"documentation": "True if the concept could be translated",
"type": "boolean"
},
{
"name": "message",
"min": 0,
"max": "1",
"documentation": "Error details, if result = false. If this is provided when result = true, the message carries hints and wanrings",
"type": "string"
},
{
"name": "equivalence",
"min": 0,
"max": "1",
"documentation": "A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-equivalence.html}. TODO: what about multiple translations?",
"type": "code"
},
{
"name": "outcome",
"min": 0,
"max": "1",
"documentation": "The translation outcome - a CodeableConcept to allow for multiple translations",
"type": "CodeableConcept"
}
]
}
]
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "ConceptMap-closure",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure",
"name": "Closure Table Maintenance",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation provides support for ongoing maintenance of a client-side closure table based on server-side terminological logic. For details of how this is used, see [Maintaining a Closure Table](terminology-service.html#closure)",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "closure",
"system": true,
"instance": false,
"parameter": [
{
"name": "name",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The name that defines the particular context for the subsumption based closure table",
"type": "string"
},
{
"name": "concept",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Concepts to add to the closure table",
"type": "Coding"
},
{
"name": "version",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A request to resynchronise - request to send all new entries since the nominated version was sent by the server",
"type": "id"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping equivalences that can be returned are equal, narrower, wider, and unmatched",
"type": "ConceptMap"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ConceptMap",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"name": "ConceptMap",
"publisher": "HL7 FHIR Project (Vocabulary)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ConceptMap Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ConceptMap",
"short": "A map from one set of concepts to one or more other concepts",
"definition": "A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.",
"min": 1,
"max": "1",
"type": [
{
"code": "ConceptMap"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ConceptMap.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ConceptMap.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ConceptMap.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ConceptMap.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ConceptMap.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.url",
"short": "Globally unique logical id for concept map",
"definition": "An absolute uri that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "Formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ConceptMap.version",
"short": "Logical id for this version of the concept map",
"definition": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the concept map that have this same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.name",
"short": "Informal name for this concept map",
"definition": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.useContext",
"short": "Content intends to support these contexts",
"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 of concept maps.",
"requirements": "Assist in searching for appropriate concept maps.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the concept map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "ConceptMap.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the concept map.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "ConceptMap.description",
"short": "Human language description of the concept map",
"definition": "A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"requirements": "Human understandability.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.requirements",
"short": "Why is this needed?",
"definition": "Explains why this concept map is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the concept map (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents.",
"comments": "Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.status",
"short": "draft | active | retired",
"definition": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"requirements": "Identify when/if the concept map should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ConceptMap.date",
"short": "Date for given status",
"definition": "The date that the concept map status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.",
"requirements": "Need to know when a concept map was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.source[x]",
"short": "Identifies the source of the concepts which are being mapped",
"definition": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.target[x]",
"short": "Provides context to the mappings",
"definition": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.element",
"short": "Mappings for a concept from the source set",
"definition": "Mappings for an individual concept in the source to one or more concepts in the target.",
"comments": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.element.codeSystem",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.code",
"short": "Identifies element being mapped",
"definition": "Identity (code or path) or the element/item being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.dependsOn",
"name": "dependsOn",
"short": "Other elements required for this mapping (from context)",
"definition": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.",
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.dependsOn.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.dependsOn.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.dependsOn.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.element.dependsOn.element",
"short": "Reference to element/field/valueset mapping depends on",
"definition": "A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.codeSystem",
"short": "Code System (if necessary)",
"definition": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that cross code systems).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.element.map",
"short": "Target of this map",
"definition": "A concept from the target value set that this concept maps to.",
"comments": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"path": "ConceptMap.element.map.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.map.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.element.map.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.element.map.codeSystem",
"short": "System of the target (if necessary)",
"definition": "An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.map.code",
"short": "Code that identifies the target element",
"definition": "Identity (code or path) or the element/item that the map refers to.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.map.equivalence",
"short": "equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from source to target (e.g. the source is 'wider' than the target.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"strength": "required",
"description": "The degree of equivalence between concepts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
},
{
"path": "ConceptMap.element.map.comments",
"short": "Description of status/issues in mapping",
"definition": "A description of status/issues in mapping that conveys additional information not represented in the structured data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cmd-1"
]
},
{
"path": "ConceptMap.element.map.product",
"short": "Other concepts that this mapping also produces",
"definition": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.",
"min": 0,
"max": "*",
"nameReference": "dependsOn"
}
]
},
"differential": {
"element": [
{
"path": "ConceptMap",
"short": "A map from one set of concepts to one or more other concepts",
"definition": "A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.url",
"short": "Globally unique logical id for concept map",
"definition": "An absolute uri that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "Formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ConceptMap.version",
"short": "Logical id for this version of the concept map",
"definition": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the concept map that have this same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.name",
"short": "Informal name for this concept map",
"definition": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.useContext",
"short": "Content intends to support these contexts",
"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 of concept maps.",
"requirements": "Assist in searching for appropriate concept maps.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the concept map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "ConceptMap.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the concept map.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "ConceptMap.description",
"short": "Human language description of the concept map",
"definition": "A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"requirements": "Human understandability.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.requirements",
"short": "Why is this needed?",
"definition": "Explains why this concept map is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the concept map (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents.",
"comments": "Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.status",
"short": "draft | active | retired",
"definition": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"requirements": "Identify when/if the concept map should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ConceptMap.date",
"short": "Date for given status",
"definition": "The date that the concept map status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.",
"requirements": "Need to know when a concept map was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.source[x]",
"short": "Identifies the source of the concepts which are being mapped",
"definition": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.target[x]",
"short": "Provides context to the mappings",
"definition": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.element",
"short": "Mappings for a concept from the source set",
"definition": "Mappings for an individual concept in the source to one or more concepts in the target.",
"comments": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.codeSystem",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.code",
"short": "Identifies element being mapped",
"definition": "Identity (code or path) or the element/item being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.dependsOn",
"name": "dependsOn",
"short": "Other elements required for this mapping (from context)",
"definition": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.",
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.dependsOn.element",
"short": "Reference to element/field/valueset mapping depends on",
"definition": "A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.codeSystem",
"short": "Code System (if necessary)",
"definition": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that cross code systems).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.element.map",
"short": "Target of this map",
"definition": "A concept from the target value set that this concept maps to.",
"comments": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"path": "ConceptMap.element.map.codeSystem",
"short": "System of the target (if necessary)",
"definition": "An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.map.code",
"short": "Code that identifies the target element",
"definition": "Identity (code or path) or the element/item that the map refers to.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.map.equivalence",
"short": "equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from source to target (e.g. the source is 'wider' than the target.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"strength": "required",
"description": "The degree of equivalence between concepts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
},
{
"path": "ConceptMap.element.map.comments",
"short": "Description of status/issues in mapping",
"definition": "A description of status/issues in mapping that conveys additional information not represented in the structured data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cmd-1"
]
},
{
"path": "ConceptMap.element.map.product",
"short": "Other concepts that this mapping also produces",
"definition": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.",
"min": 0,
"max": "*",
"nameReference": "dependsOn"
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Condition",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Condition",
"name": "Condition",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Condition Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Condition",
"short": "Detailed information about conditions, problems or diagnoses",
"definition": "Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.",
"min": 1,
"max": "1",
"type": [
{
"code": "Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "PPR message"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]"
}
]
},
{
"path": "Condition.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Condition.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Condition.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Condition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Condition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Condition.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.identifier",
"short": "External Ids for this condition",
"definition": "This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Condition.patient",
"short": "Who has the condition?",
"definition": "Indicates the patient who the condition record is associated with.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Condition.encounter",
"short": "Encounter when condition first asserted",
"definition": "Encounter during which the condition was first asserted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19 (+PV1-54)"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Condition.asserter",
"short": "Person who asserts this condition",
"definition": "Person who takes responsibility for asserting the existence of the condition as part of the electronic record.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL-7.1 identifier + REL-7.12 type code"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Condition.dateAsserted",
"short": "When first detected/suspected/entered",
"definition": "Estimated or actual date the condition/problem/diagnosis was first detected/suspected.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL-11"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Condition.code",
"short": "Identification of the condition, problem or diagnosis",
"definition": "Identification of the condition, problem or diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-3"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Condition.category",
"short": "E.g. complaint | symptom | finding | diagnosis",
"definition": "A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis.",
"comments": "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionCategory",
"strength": "required",
"description": "A category assigned to the condition. E.g. finding | Condition | diagnosis | concern | condition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-category"
}
},
"mapping": [
{
"identity": "v2",
"map": "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Condition.clinicalStatus",
"short": "provisional | working | confirmed | refuted | entered-in-error | unknown",
"definition": "The clinical status of the condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConditionClinicalStatus",
"strength": "required",
"description": "The clinical status of the Condition or diagnosis",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-14 / DG1-6"
},
{
"identity": "rim",
"map": ".code (pre or post-coordinated in)\n\nCan use valueNegationInd for refuted"
}
]
},
{
"path": "Condition.severity",
"short": "Subjective severity of condition",
"definition": "A subjective assessment of the severity of the condition as evaluated by the clinician.",
"comments": "Coding of the severity with a terminology is preferred, where possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionSeverity",
"strength": "example",
"description": "A subjective assessment of the severity of the condition as evaluated by the clinician.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-severity"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-26 / ABS-3"
},
{
"identity": "rim",
"map": "Can be pre/post-coordinated into value. Or\n./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value"
}
]
},
{
"path": "Condition.onset[x]",
"short": "Estimated or actual date, date-time, or age",
"definition": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.",
"comments": "Age is generally used when the patient reports an age at which the Condition began to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Age"
},
{
"code": "Period"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-16"
},
{
"identity": "rim",
"map": ".effectiveTime.low\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value"
}
]
},
{
"path": "Condition.abatement[x]",
"short": "If/when in resolution/remission",
"definition": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.",
"comments": "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated.\n\nIf there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Age"
},
{
"code": "boolean"
},
{
"code": "Period"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value\nor\n.inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed"
}
]
},
{
"path": "Condition.stage",
"short": "Stage/grade, usually assessed formally",
"definition": "Clinical stage or grade of a condition. May include formal severity assessments.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "con-1",
"name": "Stage rule",
"severity": "error",
"human": "Stage SHALL have summary or assessment",
"xpath": "exists(f:summary) or exists(f:assessment)"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]"
}
]
},
{
"path": "Condition.stage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.stage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.stage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.stage.summary",
"short": "Simple summary (disease specific)",
"definition": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-1"
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Condition.stage.assessment",
"short": "Formal record of assessment",
"definition": "Reference to a formal record of the evidence on which the staging assessment is based.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"con-1"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.evidence",
"short": "Supporting evidence",
"definition": "Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.",
"comments": "The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-2",
"name": "Evidence",
"severity": "error",
"human": "evidence SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.evidence.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.evidence.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.evidence.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.evidence.code",
"short": "Manifestation/symptom",
"definition": "A manifestation or symptom that led to the recording of this condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-2"
],
"mapping": [
{
"identity": "rim",
"map": "[code=\"diagnosis\"].value"
}
]
},
{
"path": "Condition.evidence.detail",
"short": "Supporting information found elsewhere",
"definition": "Links to other relevant information, including pathology reports.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"con-2"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.location",
"short": "Anatomical location, if relevant",
"definition": "The anatomical location where this condition manifests itself.",
"comments": "May be a summary code, or a reference to a very precise definition of the location, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-3",
"name": "Location",
"severity": "error",
"human": "location SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".targetBodySiteCode"
}
]
},
{
"path": "Condition.location.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.location.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.location.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.location.code",
"short": "Location - may include laterality",
"definition": "Code that identifies the structural location.",
"comments": "May include laterality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-3"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.location.detail",
"short": "Precise location details",
"definition": "Detailed anatomical location information.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"con-3"
],
"mapping": [
{
"identity": "rim",
"map": ".originalText"
}
]
},
{
"path": "Condition.dueTo",
"short": "Causes for this Condition",
"definition": "Further conditions, problems, diagnoses, procedures or events or the substance that caused/triggered this Condition.",
"comments": "Although a condition may be caused by a substance, this is not intended to be used to record allergies/adverse reactions to substances.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-4",
"name": "Relationship1",
"severity": "error",
"human": "Relationship SHALL have either a code or a target",
"xpath": "exists(f:code) != exists(f:target)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Condition.dueTo.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.dueTo.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.dueTo.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.dueTo.code",
"short": "Relationship target by means of a predefined code",
"definition": "Code that identifies the target of this relationship. The code takes the place of a detailed instance target.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-4"
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN].code"
}
]
},
{
"path": "Condition.dueTo.target",
"short": "Relationship target resource",
"definition": "Target of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}
],
"condition": [
"con-4"
],
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.occurredFollowing",
"short": "Precedent for this Condition",
"definition": "Further conditions, problems, diagnoses, procedures or events or the substance that preceded this Condition.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-5",
"name": "Relationship2",
"severity": "error",
"human": "Relationship SHALL have either a code or a target",
"xpath": "exists(f:code) != exists(f:target)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Condition.occurredFollowing.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.occurredFollowing.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Condition.occurredFollowing.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Condition.occurredFollowing.code",
"short": "Relationship target by means of a predefined code",
"definition": "Code that identifies the target of this relationship. The code takes the place of a detailed instance target.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-5"
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN].code"
}
]
},
{
"path": "Condition.occurredFollowing.target",
"short": "Relationship target resource",
"definition": "Target of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}
],
"condition": [
"con-5"
],
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.notes",
"short": "Additional information about the Condition",
"definition": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE child of PRB"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Condition",
"short": "Detailed information about conditions, problems or diagnoses",
"definition": "Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "PPR message"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]"
}
]
},
{
"path": "Condition.identifier",
"short": "External Ids for this condition",
"definition": "This records identifiers associated with this condition that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Condition.patient",
"short": "Who has the condition?",
"definition": "Indicates the patient who the condition record is associated with.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Condition.encounter",
"short": "Encounter when condition first asserted",
"definition": "Encounter during which the condition was first asserted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19 (+PV1-54)"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Condition.asserter",
"short": "Person who asserts this condition",
"definition": "Person who takes responsibility for asserting the existence of the condition as part of the electronic record.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL-7.1 identifier + REL-7.12 type code"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Condition.dateAsserted",
"short": "When first detected/suspected/entered",
"definition": "Estimated or actual date the condition/problem/diagnosis was first detected/suspected.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "REL-11"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Condition.code",
"short": "Identification of the condition, problem or diagnosis",
"definition": "Identification of the condition, problem or diagnosis.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-3"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Condition.category",
"short": "E.g. complaint | symptom | finding | diagnosis",
"definition": "A category assigned to the condition. E.g. complaint | symptom | finding | diagnosis.",
"comments": "The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionCategory",
"strength": "required",
"description": "A category assigned to the condition. E.g. finding | Condition | diagnosis | concern | condition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-category"
}
},
"mapping": [
{
"identity": "v2",
"map": "'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Condition.clinicalStatus",
"short": "provisional | working | confirmed | refuted | entered-in-error | unknown",
"definition": "The clinical status of the condition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConditionClinicalStatus",
"strength": "required",
"description": "The clinical status of the Condition or diagnosis",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-14 / DG1-6"
},
{
"identity": "rim",
"map": ".code (pre or post-coordinated in)\n\nCan use valueNegationInd for refuted"
}
]
},
{
"path": "Condition.severity",
"short": "Subjective severity of condition",
"definition": "A subjective assessment of the severity of the condition as evaluated by the clinician.",
"comments": "Coding of the severity with a terminology is preferred, where possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionSeverity",
"strength": "example",
"description": "A subjective assessment of the severity of the condition as evaluated by the clinician.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-severity"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRB-26 / ABS-3"
},
{
"identity": "rim",
"map": "Can be pre/post-coordinated into value. Or\n./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"severity\"].value"
}
]
},
{
"path": "Condition.onset[x]",
"short": "Estimated or actual date, date-time, or age",
"definition": "Estimated or actual date or date-time the condition began, in the opinion of the clinician.",
"comments": "Age is generally used when the patient reports an age at which the Condition began to occur.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Age"
},
{
"code": "Period"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRB-16"
},
{
"identity": "rim",
"map": ".effectiveTime.low\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at onset\"].value"
}
]
},
{
"path": "Condition.abatement[x]",
"short": "If/when in resolution/remission",
"definition": "The date or estimated date that the condition resolved or went into remission. This is called \"abatement\" because of the many overloaded connotations associated with \"remission\" or \"resolution\" - Conditions are never really resolved, but they can abate.",
"comments": "There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated.\n\nIf there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
},
{
"code": "Age"
},
{
"code": "boolean"
},
{
"code": "Period"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high\nor\n.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age at remission\"].value\nor\n.inboundRelationship[typeCode=SUBJ]source[classCode=CONC, moodCode=EVN].status=completed"
}
]
},
{
"path": "Condition.stage",
"short": "Stage/grade, usually assessed formally",
"definition": "Clinical stage or grade of a condition. May include formal severity assessments.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "con-1",
"name": "Stage rule",
"severity": "error",
"human": "Stage SHALL have summary or assessment",
"xpath": "exists(f:summary) or exists(f:assessment)"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"stage/grade\"]"
}
]
},
{
"path": "Condition.stage.summary",
"short": "Simple summary (disease specific)",
"definition": "A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-1"
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Condition.stage.assessment",
"short": "Formal record of assessment",
"definition": "Reference to a formal record of the evidence on which the staging assessment is based.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"con-1"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.evidence",
"short": "Supporting evidence",
"definition": "Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.",
"comments": "The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-2",
"name": "Evidence",
"severity": "error",
"human": "evidence SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SPRT].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.evidence.code",
"short": "Manifestation/symptom",
"definition": "A manifestation or symptom that led to the recording of this condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-2"
],
"mapping": [
{
"identity": "rim",
"map": "[code=\"diagnosis\"].value"
}
]
},
{
"path": "Condition.evidence.detail",
"short": "Supporting information found elsewhere",
"definition": "Links to other relevant information, including pathology reports.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"condition": [
"con-2"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.location",
"short": "Anatomical location, if relevant",
"definition": "The anatomical location where this condition manifests itself.",
"comments": "May be a summary code, or a reference to a very precise definition of the location, or both.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-3",
"name": "Location",
"severity": "error",
"human": "location SHALL have code or details",
"xpath": "exists(f:code) or exists(f:detail)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".targetBodySiteCode"
}
]
},
{
"path": "Condition.location.code",
"short": "Location - may include laterality",
"definition": "Code that identifies the structural location.",
"comments": "May include laterality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-3"
],
"mapping": [
{
"identity": "rim",
"map": ".self"
}
]
},
{
"path": "Condition.location.detail",
"short": "Precise location details",
"definition": "Detailed anatomical location information.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"con-3"
],
"mapping": [
{
"identity": "rim",
"map": ".originalText"
}
]
},
{
"path": "Condition.dueTo",
"short": "Causes for this Condition",
"definition": "Further conditions, problems, diagnoses, procedures or events or the substance that caused/triggered this Condition.",
"comments": "Although a condition may be caused by a substance, this is not intended to be used to record allergies/adverse reactions to substances.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-4",
"name": "Relationship1",
"severity": "error",
"human": "Relationship SHALL have either a code or a target",
"xpath": "exists(f:code) != exists(f:target)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Condition.dueTo.code",
"short": "Relationship target by means of a predefined code",
"definition": "Code that identifies the target of this relationship. The code takes the place of a detailed instance target.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-4"
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN].code"
}
]
},
{
"path": "Condition.dueTo.target",
"short": "Relationship target resource",
"definition": "Target of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}
],
"condition": [
"con-4"
],
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.occurredFollowing",
"short": "Precedent for this Condition",
"definition": "Further conditions, problems, diagnoses, procedures or events or the substance that preceded this Condition.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "con-5",
"name": "Relationship2",
"severity": "error",
"human": "Relationship SHALL have either a code or a target",
"xpath": "exists(f:code) != exists(f:target)"
}
],
"mapping": [
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Condition.occurredFollowing.code",
"short": "Relationship target by means of a predefined code",
"definition": "Code that identifies the target of this relationship. The code takes the place of a detailed instance target.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"con-5"
],
"binding": {
"name": "ConditionKind",
"strength": "example",
"description": "Identification of the Condition or diagnosis.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/condition-code"
}
},
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN].code"
}
]
},
{
"path": "Condition.occurredFollowing.target",
"short": "Relationship target resource",
"definition": "Target of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
}
],
"condition": [
"con-5"
],
"mapping": [
{
"identity": "rim",
"map": ".target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Condition.notes",
"short": "Additional information about the Condition",
"definition": "Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE child of PRB"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Conformance",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Conformance",
"name": "Conformance",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Conformance Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Conformance",
"short": "A conformance statement",
"definition": "A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.",
"min": 1,
"max": "1",
"type": [
{
"code": "Conformance"
}
],
"constraint": [
{
"key": "cnf-1",
"name": "Content Required",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of rest, messaging or document",
"xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)"
},
{
"key": "cnf-2",
"name": "Details",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of description, software, or implementation",
"xpath": "count(f:software | f:implementation | f:description) > 0"
},
{
"key": "cnf-4",
"name": "End point populated when multiple",
"severity": "error",
"human": "If there is more than one messaging element, endpoint must be specified for each one",
"xpath": "count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])"
},
{
"key": "cnf-5",
"name": "Messaging endpoints unique",
"severity": "error",
"human": "The set of end points listed for messaging must be unique",
"xpath": "count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))"
},
{
"key": "cnf-7",
"name": "Document unique",
"severity": "error",
"human": "The set of documents must be unique by the combination of profile & mode",
"xpath": "count(f:document[f:mode='producer'])=count(distinct-values(f:document[f:mode='producer']/f:profile/@value)) and count(f:document[f:mode='consumer'])=count(distinct-values(f:document[f:mode='consumer']/f:profile/@value))"
},
{
"key": "cnf-8",
"name": "Rest unique by mode",
"severity": "error",
"human": "There can only be one REST declaration per mode",
"xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"
}
]
},
{
"path": "Conformance.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Conformance.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Conformance.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Conformance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Conformance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Conformance.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.url",
"short": "Logical uri to reference this statement",
"definition": "An absolute uri that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Conformance.version",
"short": "Logical id for this version of the statement",
"definition": "The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple different instances of a conformance statement that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.name",
"short": "Informal name for this conformance statement",
"definition": "A free text natural language name identifying the conformance statement.",
"comments": "The name is not expected to be globally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the conformance.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the conformance. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "Conformance.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the conformance.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "Conformance.description",
"short": "Human description of the conformance statement",
"definition": "A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comments": "This field cmay include the purpose of this conformance statement, comments about its context etc. This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.requirements",
"short": "Why is this needed?",
"definition": "Explains why this conformance statement is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the conformance statement (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the conformamce statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statement.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.status",
"short": "draft | active | retired",
"definition": "The status of this conformance statement.",
"comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "Conformance.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of conformance statements that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "Conformance.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the conformance statement was published.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Conformance.software",
"short": "Software that is covered by this conformance statement",
"definition": "Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation.",
"min": 0,
"max": "1",
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.software.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.software.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.software.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.software.name",
"short": "A name the software is known by",
"definition": "Name software is known by.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.software.version",
"short": "Version covered by this statement",
"definition": "The version identifier for the software covered by this statement.",
"comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.software.releaseDate",
"short": "Date this version released",
"definition": "Date this version of the software released.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Conformance.implementation",
"short": "If this describes a specific instance",
"definition": "Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min": 0,
"max": "1",
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.implementation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.implementation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.implementation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.implementation.description",
"short": "Describes this specific instance",
"definition": "Information about the specific installation that this conformance statement relates to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.implementation.url",
"short": "Base URL for the installation",
"definition": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Conformance.fhirVersion",
"short": "FHIR Version",
"definition": "The version of the FHIR specification on which this conformance statement is based.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Conformance.acceptUnknown",
"short": "True if application accepts unknown elements",
"definition": "A flag that indicates whether the application accepts unknown elements as part of a resource.",
"comments": "This is not about extensions, but about unknown elements in a resource - these can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence this element is about inter-version compatibility.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "Conformance.format",
"short": "formats supported (xml | json | mime type)",
"definition": "A list of the formats supported by this implementation using their content types.",
"comments": "\"xml\" or \"json\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Conformance.profile",
"short": "Profiles supported by the system",
"definition": "A list of profiles supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile.",
"comments": "Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports- this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).\n\nTypical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However they do not need to describe more than one resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.rest",
"short": "If the endpoint is a RESTful one",
"definition": "A definition of the restful capabilities of the solution, if any.",
"comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
],
"constraint": [
{
"key": "cnf-10",
"name": "Query unique in rest mode",
"severity": "error",
"human": "A given query can only be described once per RESTful mode",
"xpath": "count(f:query)=count(distinct-values(f:query/f:name/@value))"
},
{
"key": "cnf-9",
"name": "Resource unique in rest mode",
"severity": "error",
"human": "A given resource can only be described once per RESTful mode",
"xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}
]
},
{
"path": "Conformance.rest.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.mode",
"short": "client | server",
"definition": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RestfulConformanceMode",
"strength": "required",
"description": "The mode of a RESTful conformance statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/restful-conformance-mode"
}
}
},
{
"path": "Conformance.rest.documentation",
"short": "General description of implementation",
"definition": "Information about the system's restful capabilities that apply across all applications, such as security.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.security",
"short": "Information about security of implementation",
"definition": "Information about security implementation from an interface perspective - what a client needs to know.",
"min": 0,
"max": "1"
},
{
"path": "Conformance.rest.security.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.security.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.security.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.security.cors",
"short": "Adds CORS Headers (http://enable-cors.org/)",
"definition": "Server adds CORS headers when responding to requests - this enables javascript applications to use the server.",
"comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.security.service",
"short": "OAuth | OAuth2 | NTLM | Basic | Kerberos",
"definition": "Types of security services are supported/required by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RestfulSecurityService",
"strength": "required",
"description": "Types of security services used with FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/restful-security-service"
}
}
},
{
"path": "Conformance.rest.security.description",
"short": "General description of how security works",
"definition": "General description of how security works.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.security.certificate",
"short": "Certificates associated with security profiles",
"definition": "Certificates associated with security profiles.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.security.certificate.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.security.certificate.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.security.certificate.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.security.certificate.type",
"short": "Mime type for certificate",
"definition": "Mime type for certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Conformance.rest.security.certificate.blob",
"short": "Actual certificate",
"definition": "Actual certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "Conformance.rest.resource",
"short": "Resource served on the REST interface",
"definition": "A specification of the restful capabilities of the solution for a specific resource type.",
"comments": "Max of one repetition per resource type.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "cnf-12",
"name": "SearchParam unique in resource",
"severity": "error",
"human": "Search parameter names must be unique in the context of a resource",
"xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
},
{
"key": "cnf-11",
"name": "Operation unique in resource",
"severity": "error",
"human": "Operation codes must be unique in the context of a resource",
"xpath": "count(f:operation)=count(distinct-values(f:operation/f:code/@value))"
}
]
},
{
"path": "Conformance.rest.resource.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.resource.type",
"short": "A resource type that is supported",
"definition": "A type of resource exposed via the restful interface.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.rest.resource.profile",
"short": "What structural features are supported",
"definition": "A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.",
"comments": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.rest.resource.interaction",
"short": "What operations are supported?",
"definition": "Identifies a restful operation supported by the solution.",
"min": 1,
"max": "*"
},
{
"path": "Conformance.rest.resource.interaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.interaction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.interaction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.resource.interaction.code",
"short": "read | vread | update | delete | history-instance | validate | history-type | create | search-type",
"definition": "Coded identifier of the operation, supported by the system resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "TypeRestfulInteraction",
"strength": "required",
"description": "Operations supported by REST at the type or instance level",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/type-restful-interaction"
}
}
},
{
"path": "Conformance.rest.resource.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements": "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.versioning",
"short": "no-version | versioned | versioned-update",
"definition": "Thi field is set to true to specify that the system does not support (server) or use (client) versioning for this resource type. If this is not set to true, the server must at least correctly track and populate the versionId meta-property on resources.",
"comments": "If a server supports versionIds correctly, it should support vread too, but is not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceVersionPolicy",
"strength": "required",
"description": "How the system supports versioning for a resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/versioning-policy"
}
}
},
{
"path": "Conformance.rest.resource.readHistory",
"short": "Whether vRead can return past versions",
"definition": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.updateCreate",
"short": "If update can commit to a new identity",
"definition": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.",
"comments": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalCreate",
"short": "If allows/uses conditional create",
"definition": "A flag that indicates that the server supports conditional create.",
"comments": "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalUpdate",
"short": "If allows/uses conditional update",
"definition": "A flag that indicates that the server supports conditional update.",
"comments": "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalDelete",
"short": "If allows/uses conditional delete",
"definition": "A flag that indicates that the server supports conditional delete.",
"comments": "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.searchInclude",
"short": "_include values supported by the server",
"definition": "A list of _include values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam",
"short": "Search params supported by implementation",
"definition": "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.resource.searchParam.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.name",
"short": "Name of search parameter",
"definition": "The name of the search parameter used in the interface.",
"comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.definition",
"short": "Source of definition for parameter",
"definition": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).",
"comments": "This SHOULD be present, and matches SearchParameter.url.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"comments": "While this can be looked up from the definition, it is included here as a convenience for systems that auto-generate a query interface based on the server conformance statement. It SHALL be the same as the type in the search parameter definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchParamType",
"strength": "required",
"description": "Data types allowed to be used for search parameters",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
},
{
"path": "Conformance.rest.resource.searchParam.documentation",
"short": "Server-specific usage",
"definition": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"comments": "This SHALL be the same as or a proper subset of the resources listed in the search parameter definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.rest.resource.searchParam.chain",
"short": "Chained names supported",
"definition": "Chained names supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.interaction",
"short": "What operations are supported?",
"definition": "A specification of restful operations supported by the system.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.interaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.interaction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.interaction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.interaction.code",
"short": "transaction | search-system | history-system",
"definition": "A coded identifier of the operation, supported by the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SystemRestfulInteraction",
"strength": "required",
"description": "Operations supported by REST at the system level",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/system-restful-interaction"
}
}
},
{
"path": "Conformance.rest.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.operation",
"short": "Definition of an operation or a custom query",
"definition": "Definition of an operation or a named query and with its parameters and their meaning and type.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.operation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.operation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.rest.operation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.rest.operation.name",
"short": "Name by which the operation/query is invoked",
"definition": "The name of a query, which is used in the _query parameter when the query is called.",
"comments": "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.operation.definition",
"short": "The defined operation/query",
"definition": "Where the formal definition can be found.",
"comments": "This can be used to build ah HTML form to invoke the operation, for instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
},
{
"path": "Conformance.rest.documentMailbox",
"short": "How documents are accepted in /Mailbox",
"definition": "A list of absolute URIs that identify profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose.",
"comments": "If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.rest.compartment",
"short": "Compartments served/used by system",
"definition": "An absolute URI which is a reference to the definition of a compartment hosted by the system.",
"comments": "At present, the only defined compartments are at [[extras.html]].",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.messaging",
"short": "If messaging is supported",
"definition": "A description of the messaging capabilities of the solution.",
"comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
],
"constraint": [
{
"key": "cnf-3",
"name": "End points for Implementations",
"severity": "error",
"human": "Messaging end point is required (and is only permitted) when statement is for an implementation",
"xpath": "exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"
},
{
"key": "cnf-6",
"name": "Event unique",
"severity": "error",
"human": "The set of events per messaging endpoint must be unique by the combination of code & mode",
"xpath": "count(f:event[f:mode='sender'])=count(distinct-values(f:event[f:mode='sender']/f:code/@value)) and count(f:event[f:mode='receiver'])=count(distinct-values(f:event[f:mode='receiver']/f:code/@value))"
}
]
},
{
"path": "Conformance.messaging.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.messaging.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.messaging.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.messaging.endpoint",
"short": "Actual endpoint being described",
"definition": "An address to which messages and/or replies are to be sent.",
"comments": "For solutions that do not use network addresses for routing, it can be just an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"cnf-3"
]
},
{
"path": "Conformance.messaging.reliableCache",
"short": "Reliable Message Cache Length (min)",
"definition": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comments": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Conformance.messaging.documentation",
"short": "Messaging interface behavior details",
"definition": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.messaging.event",
"short": "Declare support for this event",
"definition": "A description of the solution's support for an event at this end point.",
"comments": "The same event may be listed up to two times - once as sender and once as receiver.",
"min": 1,
"max": "*"
},
{
"path": "Conformance.messaging.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.messaging.event.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.messaging.event.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.messaging.event.code",
"short": "Event type",
"definition": "A coded identifier of a supported messaging event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MessageEvent",
"strength": "preferred",
"description": "One of the message events defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-events"
}
}
},
{
"path": "Conformance.messaging.event.category",
"short": "Consequence | Currency | Notification",
"definition": "The impact of the content of the message.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MessageSignificanceCategory",
"strength": "required",
"description": "The impact of the content of a message",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-significance-category"
}
}
},
{
"path": "Conformance.messaging.event.mode",
"short": "sender | receiver",
"definition": "The mode of this event declaration - whether application is sender or receiver.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ConformanceEventMode",
"strength": "required",
"description": "The mode of a message conformance statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-conformance-event-mode"
}
}
},
{
"path": "Conformance.messaging.event.protocol",
"short": "http | ftp | mllp +",
"definition": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MessageTransport",
"strength": "required",
"description": "The protocol used for message transport",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-transport"
}
}
},
{
"path": "Conformance.messaging.event.focus",
"short": "Resource that's focus of message",
"definition": "A resource associated with the event. This is the resource that defines the event.",
"comments": "This SHALL be provided if the event type supports multiple different resource types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.messaging.event.request",
"short": "Profile that describes the request",
"definition": "Information about the request for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.messaging.event.response",
"short": "Profile that describes the response",
"definition": "Information about the response for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.messaging.event.documentation",
"short": "Endpoint-specific event documentation",
"definition": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.document",
"short": "Document definition",
"definition": "A document definition.",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
]
},
{
"path": "Conformance.document.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.document.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Conformance.document.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Conformance.document.mode",
"short": "producer | consumer",
"definition": "Mode of this document declaration - whether application is producer or consumer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DocumentMode",
"strength": "required",
"description": "Whether the application produces or consumes documents",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-mode"
}
}
},
{
"path": "Conformance.document.documentation",
"short": "Description of document support",
"definition": "A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.document.profile",
"short": "Constraint on a resource used in the document",
"definition": "A constraint on a resource used in the document.",
"comments": "The first resource is the document resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Conformance",
"short": "A conformance statement",
"definition": "A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "cnf-1",
"name": "Content Required",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of rest, messaging or document",
"xpath": "exists(f:rest) or exists(f:messaging) or exists(f:document)"
},
{
"key": "cnf-2",
"name": "Details",
"severity": "error",
"human": "A Conformance statement SHALL have at least one of description, software, or implementation",
"xpath": "count(f:software | f:implementation | f:description) > 0"
},
{
"key": "cnf-4",
"name": "End point populated when multiple",
"severity": "error",
"human": "If there is more than one messaging element, endpoint must be specified for each one",
"xpath": "count(f:messaging)<=1 or not(f:messaging[not(f:endpoint)])"
},
{
"key": "cnf-5",
"name": "Messaging endpoints unique",
"severity": "error",
"human": "The set of end points listed for messaging must be unique",
"xpath": "count(f:messaging/f:endpoint)=count(distinct-values(f:messaging/f:endpoint/@value))"
},
{
"key": "cnf-7",
"name": "Document unique",
"severity": "error",
"human": "The set of documents must be unique by the combination of profile & mode",
"xpath": "count(f:document[f:mode='producer'])=count(distinct-values(f:document[f:mode='producer']/f:profile/@value)) and count(f:document[f:mode='consumer'])=count(distinct-values(f:document[f:mode='consumer']/f:profile/@value))"
},
{
"key": "cnf-8",
"name": "Rest unique by mode",
"severity": "error",
"human": "There can only be one REST declaration per mode",
"xpath": "count(f:rest)=count(distinct-values(f:rest/f:mode/@value))"
}
]
},
{
"path": "Conformance.url",
"short": "Logical uri to reference this statement",
"definition": "An absolute uri that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Conformance.version",
"short": "Logical id for this version of the statement",
"definition": "The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple different instances of a conformance statement that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.name",
"short": "Informal name for this conformance statement",
"definition": "A free text natural language name identifying the conformance statement.",
"comments": "The name is not expected to be globally unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the conformance.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the conformance. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "Conformance.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the conformance.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "Conformance.description",
"short": "Human description of the conformance statement",
"definition": "A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comments": "This field cmay include the purpose of this conformance statement, comments about its context etc. This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.requirements",
"short": "Why is this needed?",
"definition": "Explains why this conformance statement is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the conformance statement (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the conformamce statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statement.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.status",
"short": "draft | active | retired",
"definition": "The status of this conformance statement.",
"comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "Conformance.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of conformance statements that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "Conformance.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the conformance statement was published.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Conformance.software",
"short": "Software that is covered by this conformance statement",
"definition": "Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation.",
"min": 0,
"max": "1",
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.software.name",
"short": "A name the software is known by",
"definition": "Name software is known by.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.software.version",
"short": "Version covered by this statement",
"definition": "The version identifier for the software covered by this statement.",
"comments": "If possible, version should be specified, as statements are likely to be different for different versions of software.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.software.releaseDate",
"short": "Date this version released",
"definition": "Date this version of the software released.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Conformance.implementation",
"short": "If this describes a specific instance",
"definition": "Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min": 0,
"max": "1",
"condition": [
"cnf-2"
],
"isSummary": true
},
{
"path": "Conformance.implementation.description",
"short": "Describes this specific instance",
"definition": "Information about the specific installation that this conformance statement relates to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "Conformance.implementation.url",
"short": "Base URL for the installation",
"definition": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "Conformance.fhirVersion",
"short": "FHIR Version",
"definition": "The version of the FHIR specification on which this conformance statement is based.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "Conformance.acceptUnknown",
"short": "True if application accepts unknown elements",
"definition": "A flag that indicates whether the application accepts unknown elements as part of a resource.",
"comments": "This is not about extensions, but about unknown elements in a resource - these can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence this element is about inter-version compatibility.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "Conformance.format",
"short": "formats supported (xml | json | mime type)",
"definition": "A list of the formats supported by this implementation using their content types.",
"comments": "\"xml\" or \"json\" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Conformance.profile",
"short": "Profiles supported by the system",
"definition": "A list of profiles supported by the system. For a server, \"supported by the system\" means the system hosts/produces a set of resources, conformant to a particular profile, and allows its clients to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile.",
"comments": "Supported profiles are different to the profiles that apply to a particular resource in rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports- this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that does? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).\n\nTypical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However they do not need to describe more than one resource.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.rest",
"short": "If the endpoint is a RESTful one",
"definition": "A definition of the restful capabilities of the solution, if any.",
"comments": "Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
],
"constraint": [
{
"key": "cnf-10",
"name": "Query unique in rest mode",
"severity": "error",
"human": "A given query can only be described once per RESTful mode",
"xpath": "count(f:query)=count(distinct-values(f:query/f:name/@value))"
},
{
"key": "cnf-9",
"name": "Resource unique in rest mode",
"severity": "error",
"human": "A given resource can only be described once per RESTful mode",
"xpath": "count(f:resource)=count(distinct-values(f:resource/f:type/@value))"
}
]
},
{
"path": "Conformance.rest.mode",
"short": "client | server",
"definition": "Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RestfulConformanceMode",
"strength": "required",
"description": "The mode of a RESTful conformance statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/restful-conformance-mode"
}
}
},
{
"path": "Conformance.rest.documentation",
"short": "General description of implementation",
"definition": "Information about the system's restful capabilities that apply across all applications, such as security.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.security",
"short": "Information about security of implementation",
"definition": "Information about security implementation from an interface perspective - what a client needs to know.",
"min": 0,
"max": "1"
},
{
"path": "Conformance.rest.security.cors",
"short": "Adds CORS Headers (http://enable-cors.org/)",
"definition": "Server adds CORS headers when responding to requests - this enables javascript applications to use the server.",
"comments": "The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.security.service",
"short": "OAuth | OAuth2 | NTLM | Basic | Kerberos",
"definition": "Types of security services are supported/required by the system.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RestfulSecurityService",
"strength": "required",
"description": "Types of security services used with FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/restful-security-service"
}
}
},
{
"path": "Conformance.rest.security.description",
"short": "General description of how security works",
"definition": "General description of how security works.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.security.certificate",
"short": "Certificates associated with security profiles",
"definition": "Certificates associated with security profiles.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.security.certificate.type",
"short": "Mime type for certificate",
"definition": "Mime type for certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MimeType",
"strength": "required",
"description": "The mime type of an attachment",
"valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"path": "Conformance.rest.security.certificate.blob",
"short": "Actual certificate",
"definition": "Actual certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
]
},
{
"path": "Conformance.rest.resource",
"short": "Resource served on the REST interface",
"definition": "A specification of the restful capabilities of the solution for a specific resource type.",
"comments": "Max of one repetition per resource type.",
"min": 1,
"max": "*",
"constraint": [
{
"key": "cnf-12",
"name": "SearchParam unique in resource",
"severity": "error",
"human": "Search parameter names must be unique in the context of a resource",
"xpath": "count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value))"
},
{
"key": "cnf-11",
"name": "Operation unique in resource",
"severity": "error",
"human": "Operation codes must be unique in the context of a resource",
"xpath": "count(f:operation)=count(distinct-values(f:operation/f:code/@value))"
}
]
},
{
"path": "Conformance.rest.resource.type",
"short": "A resource type that is supported",
"definition": "A type of resource exposed via the restful interface.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.rest.resource.profile",
"short": "What structural features are supported",
"definition": "A specification of the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.",
"comments": "The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.rest.resource.interaction",
"short": "What operations are supported?",
"definition": "Identifies a restful operation supported by the solution.",
"min": 1,
"max": "*"
},
{
"path": "Conformance.rest.resource.interaction.code",
"short": "read | vread | update | delete | history-instance | validate | history-type | create | search-type",
"definition": "Coded identifier of the operation, supported by the system resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "TypeRestfulInteraction",
"strength": "required",
"description": "Operations supported by REST at the type or instance level",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/type-restful-interaction"
}
}
},
{
"path": "Conformance.rest.resource.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.",
"requirements": "REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.versioning",
"short": "no-version | versioned | versioned-update",
"definition": "Thi field is set to true to specify that the system does not support (server) or use (client) versioning for this resource type. If this is not set to true, the server must at least correctly track and populate the versionId meta-property on resources.",
"comments": "If a server supports versionIds correctly, it should support vread too, but is not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceVersionPolicy",
"strength": "required",
"description": "How the system supports versioning for a resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/versioning-policy"
}
}
},
{
"path": "Conformance.rest.resource.readHistory",
"short": "Whether vRead can return past versions",
"definition": "A flag for whether the server is able to return past versions as part of the vRead operation.",
"comments": "It is useful to support the vRead operation for current operations, even if past versions aren't available.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.updateCreate",
"short": "If update can commit to a new identity",
"definition": "A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.",
"comments": "Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalCreate",
"short": "If allows/uses conditional create",
"definition": "A flag that indicates that the server supports conditional create.",
"comments": "Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalUpdate",
"short": "If allows/uses conditional update",
"definition": "A flag that indicates that the server supports conditional update.",
"comments": "Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.conditionalDelete",
"short": "If allows/uses conditional delete",
"definition": "A flag that indicates that the server supports conditional delete.",
"comments": "Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Conformance.rest.resource.searchInclude",
"short": "_include values supported by the server",
"definition": "A list of _include values supported by the server.",
"comments": "If this list is empty, the server does not support includes.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam",
"short": "Search params supported by implementation",
"definition": "Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.resource.searchParam.name",
"short": "Name of search parameter",
"definition": "The name of the search parameter used in the interface.",
"comments": "Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.definition",
"short": "Source of definition for parameter",
"definition": "An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).",
"comments": "This SHOULD be present, and matches SearchParameter.url.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"comments": "While this can be looked up from the definition, it is included here as a convenience for systems that auto-generate a query interface based on the server conformance statement. It SHALL be the same as the type in the search parameter definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchParamType",
"strength": "required",
"description": "Data types allowed to be used for search parameters",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
},
{
"path": "Conformance.rest.resource.searchParam.documentation",
"short": "Server-specific usage",
"definition": "This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.resource.searchParam.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"comments": "This SHALL be the same as or a proper subset of the resources listed in the search parameter definition.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.rest.resource.searchParam.chain",
"short": "Chained names supported",
"definition": "Chained names supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.interaction",
"short": "What operations are supported?",
"definition": "A specification of restful operations supported by the system.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.interaction.code",
"short": "transaction | search-system | history-system",
"definition": "A coded identifier of the operation, supported by the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SystemRestfulInteraction",
"strength": "required",
"description": "Operations supported by REST at the system level",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/system-restful-interaction"
}
}
},
{
"path": "Conformance.rest.interaction.documentation",
"short": "Anything special about operation behavior",
"definition": "Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.operation",
"short": "Definition of an operation or a custom query",
"definition": "Definition of an operation or a named query and with its parameters and their meaning and type.",
"min": 0,
"max": "*"
},
{
"path": "Conformance.rest.operation.name",
"short": "Name by which the operation/query is invoked",
"definition": "The name of a query, which is used in the _query parameter when the query is called.",
"comments": "The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.rest.operation.definition",
"short": "The defined operation/query",
"definition": "Where the formal definition can be found.",
"comments": "This can be used to build ah HTML form to invoke the operation, for instance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
},
{
"path": "Conformance.rest.documentMailbox",
"short": "How documents are accepted in /Mailbox",
"definition": "A list of absolute URIs that identify profiles that this server implements for accepting documents in the mailbox. If this list is empty, then documents are not accepted. The base specification has the profile identifier \"http://hl7.org/fhir/documents/mailbox\". Other specifications can declare their own identifier for this purpose.",
"comments": "If a server accepts messages on the /Mailbox end-point, it declares this in the messaging elements.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.rest.compartment",
"short": "Compartments served/used by system",
"definition": "An absolute URI which is a reference to the definition of a compartment hosted by the system.",
"comments": "At present, the only defined compartments are at [[extras.html]].",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Conformance.messaging",
"short": "If messaging is supported",
"definition": "A description of the messaging capabilities of the solution.",
"comments": "Multiple repetitions allow the documentation of multiple endpoints per solution.",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
],
"constraint": [
{
"key": "cnf-3",
"name": "End points for Implementations",
"severity": "error",
"human": "Messaging end point is required (and is only permitted) when statement is for an implementation",
"xpath": "exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"
},
{
"key": "cnf-6",
"name": "Event unique",
"severity": "error",
"human": "The set of events per messaging endpoint must be unique by the combination of code & mode",
"xpath": "count(f:event[f:mode='sender'])=count(distinct-values(f:event[f:mode='sender']/f:code/@value)) and count(f:event[f:mode='receiver'])=count(distinct-values(f:event[f:mode='receiver']/f:code/@value))"
}
]
},
{
"path": "Conformance.messaging.endpoint",
"short": "Actual endpoint being described",
"definition": "An address to which messages and/or replies are to be sent.",
"comments": "For solutions that do not use network addresses for routing, it can be just an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"cnf-3"
]
},
{
"path": "Conformance.messaging.reliableCache",
"short": "Reliable Message Cache Length (min)",
"definition": "Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).",
"comments": "If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "Conformance.messaging.documentation",
"short": "Messaging interface behavior details",
"definition": "Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.messaging.event",
"short": "Declare support for this event",
"definition": "A description of the solution's support for an event at this end point.",
"comments": "The same event may be listed up to two times - once as sender and once as receiver.",
"min": 1,
"max": "*"
},
{
"path": "Conformance.messaging.event.code",
"short": "Event type",
"definition": "A coded identifier of a supported messaging event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MessageEvent",
"strength": "preferred",
"description": "One of the message events defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-events"
}
}
},
{
"path": "Conformance.messaging.event.category",
"short": "Consequence | Currency | Notification",
"definition": "The impact of the content of the message.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MessageSignificanceCategory",
"strength": "required",
"description": "The impact of the content of a message",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-significance-category"
}
}
},
{
"path": "Conformance.messaging.event.mode",
"short": "sender | receiver",
"definition": "The mode of this event declaration - whether application is sender or receiver.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ConformanceEventMode",
"strength": "required",
"description": "The mode of a message conformance statement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-conformance-event-mode"
}
}
},
{
"path": "Conformance.messaging.event.protocol",
"short": "http | ftp | mllp +",
"definition": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "MessageTransport",
"strength": "required",
"description": "The protocol used for message transport",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-transport"
}
}
},
{
"path": "Conformance.messaging.event.focus",
"short": "Resource that's focus of message",
"definition": "A resource associated with the event. This is the resource that defines the event.",
"comments": "This SHALL be provided if the event type supports multiple different resource types.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "Conformance.messaging.event.request",
"short": "Profile that describes the request",
"definition": "Information about the request for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.messaging.event.response",
"short": "Profile that describes the response",
"definition": "Information about the response for this event.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "Conformance.messaging.event.documentation",
"short": "Endpoint-specific event documentation",
"definition": "Guidance on how this event is handled, such as internal system trigger points, business rules, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.document",
"short": "Document definition",
"definition": "A document definition.",
"min": 0,
"max": "*",
"condition": [
"cnf-1"
]
},
{
"path": "Conformance.document.mode",
"short": "producer | consumer",
"definition": "Mode of this document declaration - whether application is producer or consumer.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DocumentMode",
"strength": "required",
"description": "Whether the application produces or consumes documents",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-mode"
}
}
},
{
"path": "Conformance.document.documentation",
"short": "Description of document support",
"definition": "A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Conformance.document.profile",
"short": "Constraint on a resource used in the document",
"definition": "A constraint on a resource used in the document.",
"comments": "The first resource is the document resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Contract",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Contract",
"name": "Contract",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Contract Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Contract",
"short": "Contract",
"definition": "A formal agreement between parties regarding the conduct of business, exchange of information or other matters.",
"min": 1,
"max": "1",
"type": [
{
"code": "Contract"
}
],
"mapping": [
{
"identity": "rim",
"map": "FinancialContract"
}
]
},
{
"path": "Contract.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Contract.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Contract.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Contract.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Contract.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Contract.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.identifier",
"short": "Contract identifier",
"definition": "Unique identifier for this Contract.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract id"
}
]
},
{
"path": "Contract.issued",
"short": "When this Contract was issued",
"definition": "When this Contract was issued.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract effectiveTime"
}
]
},
{
"path": "Contract.applies",
"short": "Effective time",
"definition": "Relevant time or time-period when this Contract is applicable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract activityTime"
}
]
},
{
"path": "Contract.subject",
"short": "Subject of this Contract",
"definition": "Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
},
{
"path": "Contract.authority",
"short": "Authority under which this Contract has standing",
"definition": "A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role Scoper"
}
]
},
{
"path": "Contract.domain",
"short": "Domain in which this Contract applies",
"definition": "Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.",
"alias": [
"scope of governance\njurisdication"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "Contract.type",
"short": "Contract Tyoe",
"definition": "Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContractType",
"strength": "example",
"description": "List of overall contract codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "CNTRCT"
}
]
},
{
"path": "Contract.subType",
"short": "Contract Subtype",
"definition": "More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContractSubtype",
"strength": "example",
"description": "Detailed codes within the above",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-subtype"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., RECOV"
}
]
},
{
"path": "Contract.action",
"short": "Contract Action",
"definition": "Action stipulated by this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractAction",
"strength": "example",
"description": "Detailed codes for the contract action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-action"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., JURISPOL"
}
]
},
{
"path": "Contract.actionReason",
"short": "Contract Action Reason",
"definition": "Reason for action stipulated by this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActionReason",
"strength": "example",
"description": "Detailed codes for the contract action reason",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actionreason"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., QUALIMP"
}
]
},
{
"path": "Contract.actor",
"short": "Contract Actor",
"definition": "List of Contract actors.",
"min": 0,
"max": "*"
},
{
"path": "Contract.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.actor.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.actor.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.actor.entity",
"short": "Contract Actor Type",
"definition": "Who or what actors are assigned roles in this Contract.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
]
},
{
"path": "Contract.actor.role",
"short": "Contract Actor Role",
"definition": "Role type of actors assigned roles in this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActorRole",
"strength": "example",
"description": "Detailed codes for the contract actor role",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actorrole"
}
}
},
{
"path": "Contract.valuedItem",
"short": "Contract Valued Item",
"definition": "Contract Valued Item List.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem classCode INVE"
}
]
},
{
"path": "Contract.valuedItem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.valuedItem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.valuedItem.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.valuedItem.entity[x]",
"short": "Contract Valued Item Type",
"definition": "Specific type of Contract Valued Item that may be priced.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem code"
}
]
},
{
"path": "Contract.valuedItem.identifier",
"short": "Contract Valued Item Identifier",
"definition": "Identifies a Contract Valued Item instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem id"
}
]
},
{
"path": "Contract.valuedItem.effectiveTime",
"short": "Contract Valued Item Effective Tiem",
"definition": "Indicates the time during which this Contract ValuedItem information is effective.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem effectiveTime"
}
]
},
{
"path": "Contract.valuedItem.quantity",
"short": "Count of Contract Valued Items",
"definition": "Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem unitQuantity"
}
]
},
{
"path": "Contract.valuedItem.unitPrice",
"short": "Contract Valued Item fee, charge, or cost",
"definition": "A Contract Valued Item unit valuation measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem unitPriceAmt"
}
]
},
{
"path": "Contract.valuedItem.factor",
"short": "Contract Valued Item Price Scaling Factor",
"definition": "A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem factorNumber"
}
]
},
{
"path": "Contract.valuedItem.points",
"short": "Contract Valued Item Difficulty Scaling Factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem pointNumber"
}
]
},
{
"path": "Contract.valuedItem.net",
"short": "Total Contract Valued Item Value",
"definition": "Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem netAmt"
}
]
},
{
"path": "Contract.signer",
"short": "Contract Signer",
"definition": "Party signing this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.signer.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.signer.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.signer.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.signer.type",
"short": "Contract Signer Type",
"definition": "Role of this Contract signer, e.g., notary, grantee.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ContractSignerType",
"strength": "example",
"description": "List of parties who may be signing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-signer-type"
}
}
},
{
"path": "Contract.signer.party",
"short": "Contract Signatory Party",
"definition": "Party which is a signator to this Contract.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "Contract.signer.signature",
"short": "Contract Documentation Signature",
"definition": "Legally binding Contract DSIG signature contents in Base64.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Contract.term",
"name": "term",
"short": "Contract Term List",
"definition": "One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.",
"min": 0,
"max": "*"
},
{
"path": "Contract.term.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.term.identifier",
"short": "Contract Term identifier",
"definition": "Unique identifier for this particular Contract Provision.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Contract.term.issued",
"short": "Contract Term Issue Date Time",
"definition": "When this Contract Provision was issued.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Contract.term.applies",
"short": "Contract Term Effective Time",
"definition": "Relevant time or time-period when this Contract Provision is applicable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
},
{
"path": "Contract.term.type",
"short": "Contract Term Type",
"definition": "Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g., life time maximum benefit.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractTermType",
"strength": "example",
"description": "Detailed codes for the types of contract provisions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-term-type"
}
}
},
{
"path": "Contract.term.subType",
"short": "Contract Term Subtype",
"definition": "Subtype of this Contract Provision, e.g., life time maximum payment for a contract term for specific valued item, e.g., disability payment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractTermSubType",
"strength": "example",
"description": "Detailed codes for the subtypes of contract provisions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-term-subtype"
}
}
},
{
"path": "Contract.term.subject",
"short": "Subject of this Contract Term",
"definition": "Who or what this Contract Provision is about.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "Contract.term.action",
"short": "Contract Term Action",
"definition": "Action stipulated by this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractAction",
"strength": "example",
"description": "Detailed codes for the contract action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-action"
}
}
},
{
"path": "Contract.term.actionReason",
"short": "Contract Term Action Reason",
"definition": "Reason or purpose for the action stipulated by this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActionReason",
"strength": "example",
"description": "Detailed codes for the contract action reason",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actionreason"
}
}
},
{
"path": "Contract.term.actor",
"short": "Contract Term Actor List",
"definition": "List of actors participating in this Contract Provision.",
"min": 0,
"max": "*"
},
{
"path": "Contract.term.actor.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.actor.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.actor.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.term.actor.entity",
"short": "Contract Term Actor",
"definition": "The actor assigned a role in this Contract Provision.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
]
},
{
"path": "Contract.term.actor.role",
"short": "Contract Term Actor Role",
"definition": "Role played by the actor assigned this role in this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActorRole",
"strength": "example",
"description": "Detailed codes for the contract actor role",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actorrole"
}
}
},
{
"path": "Contract.term.text",
"short": "Human readable Contract term text",
"definition": "Human readable form of this Contract Provision.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Contract.term.valuedItem",
"short": "Contract Term Valued Item",
"definition": "Contract Provision Valued Item List.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem classCode INVE"
}
]
},
{
"path": "Contract.term.valuedItem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.valuedItem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.term.valuedItem.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.term.valuedItem.entity[x]",
"short": "Contract Term Valued Item Type",
"definition": "Specific type of Contract Provision Valued Item that may be priced.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem code"
}
]
},
{
"path": "Contract.term.valuedItem.identifier",
"short": "Contract Term Valued Item Identifier",
"definition": "Identifies a Contract Provision Valued Item instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem id"
}
]
},
{
"path": "Contract.term.valuedItem.effectiveTime",
"short": "Contract Term Valued Item Effective Tiem",
"definition": "Indicates the time during which this Contract Term ValuedItem information is effective.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem effectiveTime"
}
]
},
{
"path": "Contract.term.valuedItem.quantity",
"short": "Contract Term Valued Item Count",
"definition": "Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem unitQuantity"
}
]
},
{
"path": "Contract.term.valuedItem.unitPrice",
"short": "Contract Term Valued Item fee, charge, or cost",
"definition": "A Contract Provision Valued Item unit valuation measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem unitPriceAmt"
}
]
},
{
"path": "Contract.term.valuedItem.factor",
"short": "Contract Term Valued Item Price Scaling Factor",
"definition": "A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem factorNumber"
}
]
},
{
"path": "Contract.term.valuedItem.points",
"short": "Contract Term Valued Item Difficulty Scaling Factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem pointNumber"
}
]
},
{
"path": "Contract.term.valuedItem.net",
"short": "Total Contract Term Valued Item Value",
"definition": "Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Contract.term.group",
"short": "Nested Contract Term Group",
"definition": "Nested group of Contract Provisions.",
"min": 0,
"max": "*",
"nameReference": "term"
},
{
"path": "Contract.binding[x]",
"short": "Binding Contract",
"definition": "Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.friendly",
"short": "Contract Friendly Language",
"definition": "The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.",
"min": 0,
"max": "*"
},
{
"path": "Contract.friendly.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.friendly.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.friendly.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.friendly.content[x]",
"short": "Easily comprehended representation of this Contract",
"definition": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.legal",
"short": "Contract Legal Language",
"definition": "List of Legal expressions or representations of this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.legal.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.legal.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.legal.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.legal.content[x]",
"short": "Contract Legal Text",
"definition": "Contract legal text in human renderable form.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.rule",
"short": "Computable Contract Language",
"definition": "List of Computable Policy Rule Language Representations of this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.rule.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.rule.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contract.rule.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contract.rule.content[x]",
"short": "Computable Contract Rules",
"definition": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Contract",
"short": "Contract",
"definition": "A formal agreement between parties regarding the conduct of business, exchange of information or other matters.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "FinancialContract"
}
]
},
{
"path": "Contract.identifier",
"short": "Contract identifier",
"definition": "Unique identifier for this Contract.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract id"
}
]
},
{
"path": "Contract.issued",
"short": "When this Contract was issued",
"definition": "When this Contract was issued.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract effectiveTime"
}
]
},
{
"path": "Contract.applies",
"short": "Effective time",
"definition": "Relevant time or time-period when this Contract is applicable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "FinancialContract activityTime"
}
]
},
{
"path": "Contract.subject",
"short": "Subject of this Contract",
"definition": "Who and/or what this Contract is about: typically a Patient, Organization, or valued items such as goods and services.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Role"
}
]
},
{
"path": "Contract.authority",
"short": "Authority under which this Contract has standing",
"definition": "A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role Scoper"
}
]
},
{
"path": "Contract.domain",
"short": "Domain in which this Contract applies",
"definition": "Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.",
"alias": [
"scope of governance\njurisdication"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "Contract.type",
"short": "Contract Tyoe",
"definition": "Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContractType",
"strength": "example",
"description": "List of overall contract codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "CNTRCT"
}
]
},
{
"path": "Contract.subType",
"short": "Contract Subtype",
"definition": "More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContractSubtype",
"strength": "example",
"description": "Detailed codes within the above",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-subtype"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., RECOV"
}
]
},
{
"path": "Contract.action",
"short": "Contract Action",
"definition": "Action stipulated by this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractAction",
"strength": "example",
"description": "Detailed codes for the contract action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-action"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., JURISPOL"
}
]
},
{
"path": "Contract.actionReason",
"short": "Contract Action Reason",
"definition": "Reason for action stipulated by this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActionReason",
"strength": "example",
"description": "Detailed codes for the contract action reason",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actionreason"
}
},
"mapping": [
{
"identity": "rim",
"map": "e.g., QUALIMP"
}
]
},
{
"path": "Contract.actor",
"short": "Contract Actor",
"definition": "List of Contract actors.",
"min": 0,
"max": "*"
},
{
"path": "Contract.actor.entity",
"short": "Contract Actor Type",
"definition": "Who or what actors are assigned roles in this Contract.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
]
},
{
"path": "Contract.actor.role",
"short": "Contract Actor Role",
"definition": "Role type of actors assigned roles in this Contract.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActorRole",
"strength": "example",
"description": "Detailed codes for the contract actor role",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actorrole"
}
}
},
{
"path": "Contract.valuedItem",
"short": "Contract Valued Item",
"definition": "Contract Valued Item List.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem classCode INVE"
}
]
},
{
"path": "Contract.valuedItem.entity[x]",
"short": "Contract Valued Item Type",
"definition": "Specific type of Contract Valued Item that may be priced.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem code"
}
]
},
{
"path": "Contract.valuedItem.identifier",
"short": "Contract Valued Item Identifier",
"definition": "Identifies a Contract Valued Item instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem id"
}
]
},
{
"path": "Contract.valuedItem.effectiveTime",
"short": "Contract Valued Item Effective Tiem",
"definition": "Indicates the time during which this Contract ValuedItem information is effective.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem effectiveTime"
}
]
},
{
"path": "Contract.valuedItem.quantity",
"short": "Count of Contract Valued Items",
"definition": "Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem unitQuantity"
}
]
},
{
"path": "Contract.valuedItem.unitPrice",
"short": "Contract Valued Item fee, charge, or cost",
"definition": "A Contract Valued Item unit valuation measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem unitPriceAmt"
}
]
},
{
"path": "Contract.valuedItem.factor",
"short": "Contract Valued Item Price Scaling Factor",
"definition": "A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem factorNumber"
}
]
},
{
"path": "Contract.valuedItem.points",
"short": "Contract Valued Item Difficulty Scaling Factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem pointNumber"
}
]
},
{
"path": "Contract.valuedItem.net",
"short": "Total Contract Valued Item Value",
"definition": "Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedItem netAmt"
}
]
},
{
"path": "Contract.signer",
"short": "Contract Signer",
"definition": "Party signing this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.signer.type",
"short": "Contract Signer Type",
"definition": "Role of this Contract signer, e.g., notary, grantee.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ContractSignerType",
"strength": "example",
"description": "List of parties who may be signing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-signer-type"
}
}
},
{
"path": "Contract.signer.party",
"short": "Contract Signatory Party",
"definition": "Party which is a signator to this Contract.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "Contract.signer.signature",
"short": "Contract Documentation Signature",
"definition": "Legally binding Contract DSIG signature contents in Base64.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Contract.term",
"name": "term",
"short": "Contract Term List",
"definition": "One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.",
"min": 0,
"max": "*"
},
{
"path": "Contract.term.identifier",
"short": "Contract Term identifier",
"definition": "Unique identifier for this particular Contract Provision.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Contract.term.issued",
"short": "Contract Term Issue Date Time",
"definition": "When this Contract Provision was issued.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "Contract.term.applies",
"short": "Contract Term Effective Time",
"definition": "Relevant time or time-period when this Contract Provision is applicable.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
},
{
"path": "Contract.term.type",
"short": "Contract Term Type",
"definition": "Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g., life time maximum benefit.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractTermType",
"strength": "example",
"description": "Detailed codes for the types of contract provisions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-term-type"
}
}
},
{
"path": "Contract.term.subType",
"short": "Contract Term Subtype",
"definition": "Subtype of this Contract Provision, e.g., life time maximum payment for a contract term for specific valued item, e.g., disability payment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractTermSubType",
"strength": "example",
"description": "Detailed codes for the subtypes of contract provisions",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-term-subtype"
}
}
},
{
"path": "Contract.term.subject",
"short": "Subject of this Contract Term",
"definition": "Who or what this Contract Provision is about.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "Contract.term.action",
"short": "Contract Term Action",
"definition": "Action stipulated by this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractAction",
"strength": "example",
"description": "Detailed codes for the contract action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-action"
}
}
},
{
"path": "Contract.term.actionReason",
"short": "Contract Term Action Reason",
"definition": "Reason or purpose for the action stipulated by this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActionReason",
"strength": "example",
"description": "Detailed codes for the contract action reason",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actionreason"
}
}
},
{
"path": "Contract.term.actor",
"short": "Contract Term Actor List",
"definition": "List of actors participating in this Contract Provision.",
"min": 0,
"max": "*"
},
{
"path": "Contract.term.actor.entity",
"short": "Contract Term Actor",
"definition": "The actor assigned a role in this Contract Provision.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Supply"
}
]
},
{
"path": "Contract.term.actor.role",
"short": "Contract Term Actor Role",
"definition": "Role played by the actor assigned this role in this Contract Provision.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContractActorRole",
"strength": "example",
"description": "Detailed codes for the contract actor role",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contract-actorrole"
}
}
},
{
"path": "Contract.term.text",
"short": "Human readable Contract term text",
"definition": "Human readable form of this Contract Provision.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Contract.term.valuedItem",
"short": "Contract Term Valued Item",
"definition": "Contract Provision Valued Item List.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem classCode INVE"
}
]
},
{
"path": "Contract.term.valuedItem.entity[x]",
"short": "Contract Term Valued Item Type",
"definition": "Specific type of Contract Provision Valued Item that may be priced.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem code"
}
]
},
{
"path": "Contract.term.valuedItem.identifier",
"short": "Contract Term Valued Item Identifier",
"definition": "Identifies a Contract Provision Valued Item instance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem id"
}
]
},
{
"path": "Contract.term.valuedItem.effectiveTime",
"short": "Contract Term Valued Item Effective Tiem",
"definition": "Indicates the time during which this Contract Term ValuedItem information is effective.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem effectiveTime"
}
]
},
{
"path": "Contract.term.valuedItem.quantity",
"short": "Contract Term Valued Item Count",
"definition": "Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem unitQuantity"
}
]
},
{
"path": "Contract.term.valuedItem.unitPrice",
"short": "Contract Term Valued Item fee, charge, or cost",
"definition": "A Contract Provision Valued Item unit valuation measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem unitPriceAmt"
}
]
},
{
"path": "Contract.term.valuedItem.factor",
"short": "Contract Term Valued Item Price Scaling Factor",
"definition": "A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem factorNumber"
}
]
},
{
"path": "Contract.term.valuedItem.points",
"short": "Contract Term Valued Item Difficulty Scaling Factor",
"definition": "An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "COCT_RM440000UV09 ValuedUnitItem pointNumber"
}
]
},
{
"path": "Contract.term.valuedItem.net",
"short": "Total Contract Term Valued Item Value",
"definition": "Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "Contract.term.group",
"short": "Nested Contract Term Group",
"definition": "Nested group of Contract Provisions.",
"min": 0,
"max": "*",
"nameReference": "term"
},
{
"path": "Contract.binding[x]",
"short": "Binding Contract",
"definition": "Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the \"source of truth\" and which would be the basis for legal action related to enforcement of this Contract.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.friendly",
"short": "Contract Friendly Language",
"definition": "The \"patient friendly language\" versionof the Contract in whole or in parts. \"Patient friendly language\" means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.",
"min": 0,
"max": "*"
},
{
"path": "Contract.friendly.content[x]",
"short": "Easily comprehended representation of this Contract",
"definition": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.legal",
"short": "Contract Legal Language",
"definition": "List of Legal expressions or representations of this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.legal.content[x]",
"short": "Contract Legal Text",
"definition": "Contract legal text in human renderable form.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Composition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers"
}
]
},
{
"path": "Contract.rule",
"short": "Computable Contract Language",
"definition": "List of Computable Policy Rule Language Representations of this Contract.",
"min": 0,
"max": "*"
},
{
"path": "Contract.rule.content[x]",
"short": "Computable Contract Rules",
"definition": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Contraindication",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Contraindication",
"name": "Contraindication",
"publisher": "HL7 FHIR Project (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Contraindication Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Contraindication",
"short": "Clinical issue with action",
"definition": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient. E.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.",
"alias": [
"DDI",
"drug-drug interaction",
"DetectedIssue",
"Alert"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Contraindication"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=ALRT, moodCode=EVN)"
}
]
},
{
"path": "Contraindication.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Contraindication.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Contraindication.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Contraindication.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Contraindication.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Contraindication.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.patient",
"short": "Associated patient",
"definition": "Indicates the patient whose record the contraindication is associated with.",
"requirements": "While the subject could be inferred by tracing the subject of the implicated resources, it's useful to have a direct link for query purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Contraindication.category",
"short": "E.g. Drug-drug, duplicate therapy, etc.",
"definition": "Identifies the general type of issue identified.",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationCategory",
"strength": "required",
"description": "Codes identifying the general type of contraindication. E.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.severity",
"short": "high | medium | low",
"definition": "Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.",
"alias": [
"severity"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationSeverity",
"strength": "required",
"description": "Indicates the potential degree of impact of the identified issue on the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SeverityObservation"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV].value"
}
]
},
{
"path": "Contraindication.implicated",
"short": "Problem resource",
"definition": "Indicates the resource representing the current activity or proposed activity that.",
"comments": "There's an implicit constraint on the number of implicated resources based on Contraindication.type. E.g. For drug-drug, there would be more than one. For timing, there would typically only be one.",
"alias": [
"cause"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[moodCode=EVN, INT]"
}
]
},
{
"path": "Contraindication.detail",
"short": "Description and context",
"definition": "A textual explanation of the contraindication.",
"comments": "Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Contraindication.date",
"short": "When identified",
"definition": "The date or date-time when the contraindication was initially identified.",
"requirements": "No-one can be responsible for mitigation prior to the issue being identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.author",
"short": "Who found issue?",
"definition": "Identifies the provider or software that identified the.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
},
{
"path": "Contraindication.identifier",
"short": "Unique id for the contraindication",
"definition": "Business identifier associated with the contraindication record.",
"requirements": "Allows linking instances of the same contraindication found on different servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Contraindication.reference",
"short": "Authority for issue",
"definition": "The literature, knowledge-base or similar reference that describes the propensity for the contraindication identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=INST].target[classCode=ALRT, moodCode=DEFN].text.uri"
}
]
},
{
"path": "Contraindication.mitigation",
"short": "Step taken to address",
"definition": "Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the contraindicaiton from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MITG].target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "Contraindication.mitigation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contraindication.mitigation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Contraindication.mitigation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Contraindication.mitigation.action",
"short": "What mitigation?",
"definition": "Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified contraindication.",
"comments": "The \"text\" component can be used for detail or when no appropriate code exists.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContraindicationMitigationAction",
"strength": "required",
"description": "Codes describing steps taken to resolve the contraindication or other circumstances that mitigate the risk associated with the contraindication. E.g. 'added concurrent therapy', 'prior therapy documented', etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-mitigation-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.mitigation.date",
"short": "Date committed",
"definition": "Indicates when the mitigating action was documented.",
"comments": "This may not be the same as when the mitigating step was actually taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.mitigation.author",
"short": "Who is committing?",
"definition": "Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Contraindication",
"short": "Clinical issue with action",
"definition": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient. E.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.",
"alias": [
"DDI",
"drug-drug interaction",
"DetectedIssue",
"Alert"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=ALRT, moodCode=EVN)"
}
]
},
{
"path": "Contraindication.patient",
"short": "Associated patient",
"definition": "Indicates the patient whose record the contraindication is associated with.",
"requirements": "While the subject could be inferred by tracing the subject of the implicated resources, it's useful to have a direct link for query purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Contraindication.category",
"short": "E.g. Drug-drug, duplicate therapy, etc.",
"definition": "Identifies the general type of issue identified.",
"alias": [
"type"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationCategory",
"strength": "required",
"description": "Codes identifying the general type of contraindication. E.g. Drug-drug interaction, Timing issue, Duplicate therapy, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.severity",
"short": "high | medium | low",
"definition": "Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.",
"alias": [
"severity"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ContraindicationSeverity",
"strength": "required",
"description": "Indicates the potential degree of impact of the identified issue on the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SeverityObservation"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=SEV].value"
}
]
},
{
"path": "Contraindication.implicated",
"short": "Problem resource",
"definition": "Indicates the resource representing the current activity or proposed activity that.",
"comments": "There's an implicit constraint on the number of implicated resources based on Contraindication.type. E.g. For drug-drug, there would be more than one. For timing, there would typically only be one.",
"alias": [
"cause"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[moodCode=EVN, INT]"
}
]
},
{
"path": "Contraindication.detail",
"short": "Description and context",
"definition": "A textual explanation of the contraindication.",
"comments": "Should focus on information not covered elsewhere as discrete data - no need to duplicate the narrative.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Contraindication.date",
"short": "When identified",
"definition": "The date or date-time when the contraindication was initially identified.",
"requirements": "No-one can be responsible for mitigation prior to the issue being identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.author",
"short": "Who found issue?",
"definition": "Identifies the provider or software that identified the.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
},
{
"path": "Contraindication.identifier",
"short": "Unique id for the contraindication",
"definition": "Business identifier associated with the contraindication record.",
"requirements": "Allows linking instances of the same contraindication found on different servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Contraindication.reference",
"short": "Authority for issue",
"definition": "The literature, knowledge-base or similar reference that describes the propensity for the contraindication identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=INST].target[classCode=ALRT, moodCode=DEFN].text.uri"
}
]
},
{
"path": "Contraindication.mitigation",
"short": "Step taken to address",
"definition": "Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the contraindicaiton from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MITG].target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "Contraindication.mitigation.action",
"short": "What mitigation?",
"definition": "Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified contraindication.",
"comments": "The \"text\" component can be used for detail or when no appropriate code exists.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContraindicationMitigationAction",
"strength": "required",
"description": "Codes describing steps taken to resolve the contraindication or other circumstances that mitigate the risk associated with the contraindication. E.g. 'added concurrent therapy', 'prior therapy documented', etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contraindication-mitigation-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Contraindication.mitigation.date",
"short": "Date committed",
"definition": "Indicates when the mitigating action was documented.",
"comments": "This may not be the same as when the mitigating step was actually taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Contraindication.mitigation.author",
"short": "Who is committing?",
"definition": "Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role[classCode=ASSIGNED]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Coverage",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Coverage",
"name": "Coverage",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Coverage Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "cpha3pharm",
"uri": "http://www.pharmacists.ca/",
"name": "Canadian Pharmacy Associaiton eclaims standard"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument which may be used to pay for or reimburse for health care products and services.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coverage"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Coverage.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Coverage.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Coverage.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Coverage.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Coverage.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Coverage.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Coverage.issuer",
"short": "An identifier for the plan issuer",
"definition": "The program or plan underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.30"
},
{
"identity": "v2",
"map": "IN1-3-insurance company ID"
},
{
"identity": "cdanetv4",
"map": "A05"
}
]
},
{
"path": "Coverage.bin",
"short": "BIN Number",
"definition": "Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Coverage.period",
"short": "Coverage start and end dates",
"definition": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-12-plan effective date / IN1-13-plan expiration date"
}
]
},
{
"path": "Coverage.type",
"short": "Type of coverage",
"definition": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.",
"requirements": "The order of application of coverages is dependent on the types of coverage.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"name": "CoverageType",
"strength": "example",
"description": "The type of insurance: public health, worker compensation; private accident, auto, private health, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCoverageTypeCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "IN1-15-plan type"
}
]
},
{
"path": "Coverage.subscriberId",
"short": "Subscriber ID",
"definition": "The id issued to the subscriber.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Coverage.identifier",
"short": "The primary coverage ID",
"definition": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.",
"requirements": "This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.32, C.33, C.39"
},
{
"identity": "v2",
"map": "IN1-2-health plan ID"
},
{
"identity": "cdanetv4",
"map": "C02"
}
]
},
{
"path": "Coverage.group",
"short": "An identifier for the group",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.31"
},
{
"identity": "v2",
"map": "IN1-8-group number"
},
{
"identity": "cdanetv4",
"map": "C11 (Division,Section)"
}
]
},
{
"path": "Coverage.plan",
"short": "An identifier for the plan",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-35-company plan code"
},
{
"identity": "cdanetv4",
"map": "C01"
}
]
},
{
"path": "Coverage.subPlan",
"short": "An identifier for the subsection of the plan",
"definition": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-10-insured's group emp ID"
}
]
},
{
"path": "Coverage.dependent",
"short": "The dependent number",
"definition": "A unique identifier for a dependent under the coverage.",
"requirements": "For some coverage a single identifier is issued to the PolicyHolder and dependent number issues to each to each of their dependents to track and manage the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "- No exact V2.x equivalent concept seems to exist; instance relationship can be inferred if ( ( PID-3-patient ID list ??? IN1-49-insured's ID number ) & ( ?? IN2-72-patient's relationship to insured ) )"
},
{
"identity": "cdanetv4",
"map": "C17"
}
]
},
{
"path": "Coverage.sequence",
"short": "The plan instance or sequence counter",
"definition": "An optional counter for a particular instance of the identified coverage which increments upon each renewal.",
"requirements": "Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their 'card'.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No V2.x equivalent concept seems to exist"
},
{
"identity": "cdanetv4",
"map": "D11"
}
]
},
{
"path": "Coverage.subscriber",
"short": "Plan holder information",
"definition": "The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
},
{
"path": "Coverage.network",
"short": "Insurer network",
"definition": "The identifier for a community of providers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cdanetv4",
"map": "D10"
}
]
},
{
"path": "Coverage.contract",
"short": "Contract details",
"definition": "The policy(s) which constitute this insurance coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
],
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Coverage",
"short": "Insurance or medical plan",
"definition": "Financial instrument which may be used to pay for or reimburse for health care products and services.",
"requirements": "Health care programs and insurers are significant payors of health service costs.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Coverage"
}
]
},
{
"path": "Coverage.issuer",
"short": "An identifier for the plan issuer",
"definition": "The program or plan underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.30"
},
{
"identity": "v2",
"map": "IN1-3-insurance company ID"
},
{
"identity": "cdanetv4",
"map": "A05"
}
]
},
{
"path": "Coverage.bin",
"short": "BIN Number",
"definition": "Business Identification Number (BIN number) used to identify the routing of eclaims if the insurer themselves don't have a BIN number for all of their business.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Coverage.period",
"short": "Coverage start and end dates",
"definition": "Time period during which the coverage is in force. A missing start date indicates the start date isn't known, a missing end date means the coverage is continuing to be in force.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-12-plan effective date / IN1-13-plan expiration date"
}
]
},
{
"path": "Coverage.type",
"short": "Type of coverage",
"definition": "The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.",
"requirements": "The order of application of coverages is dependent on the types of coverage.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"name": "CoverageType",
"strength": "example",
"description": "The type of insurance: public health, worker compensation; private accident, auto, private health, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActCoverageTypeCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "IN1-15-plan type"
}
]
},
{
"path": "Coverage.subscriberId",
"short": "Subscriber ID",
"definition": "The id issued to the subscriber.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "Coverage.identifier",
"short": "The primary coverage ID",
"definition": "The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Subscriber Id, Certificate number or Personal Health Number or Case ID.",
"requirements": "This value may uniquely identify the coverage or it may be used in conjunction with the additional identifiers below.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.32, C.33, C.39"
},
{
"identity": "v2",
"map": "IN1-2-health plan ID"
},
{
"identity": "cdanetv4",
"map": "C02"
}
]
},
{
"path": "Coverage.group",
"short": "An identifier for the group",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.31"
},
{
"identity": "v2",
"map": "IN1-8-group number"
},
{
"identity": "cdanetv4",
"map": "C11 (Division,Section)"
}
]
},
{
"path": "Coverage.plan",
"short": "An identifier for the plan",
"definition": "Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-35-company plan code"
},
{
"identity": "cdanetv4",
"map": "C01"
}
]
},
{
"path": "Coverage.subPlan",
"short": "An identifier for the subsection of the plan",
"definition": "Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "IN1-10-insured's group emp ID"
}
]
},
{
"path": "Coverage.dependent",
"short": "The dependent number",
"definition": "A unique identifier for a dependent under the coverage.",
"requirements": "For some coverage a single identifier is issued to the PolicyHolder and dependent number issues to each to each of their dependents to track and manage the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "- No exact V2.x equivalent concept seems to exist; instance relationship can be inferred if ( ( PID-3-patient ID list ??? IN1-49-insured's ID number ) & ( ?? IN2-72-patient's relationship to insured ) )"
},
{
"identity": "cdanetv4",
"map": "C17"
}
]
},
{
"path": "Coverage.sequence",
"short": "The plan instance or sequence counter",
"definition": "An optional counter for a particular instance of the identified coverage which increments upon each renewal.",
"requirements": "Some coverage, for example social plans, may be offered in short time increments, for example for a week or a month at a time, so while the rest of the plan details and identifiers may remain constant over time, the instance is incremented with each renewal and provided to the covered party on their 'card'.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No V2.x equivalent concept seems to exist"
},
{
"identity": "cdanetv4",
"map": "D11"
}
]
},
{
"path": "Coverage.subscriber",
"short": "Plan holder information",
"definition": "The party who 'owns' the insurance contractual relationship to the policy or to whom the benefit of the policy is due.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
},
{
"path": "Coverage.network",
"short": "Insurer network",
"definition": "The identifier for a community of providers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cdanetv4",
"map": "D10"
}
]
},
{
"path": "Coverage.contract",
"short": "Contract details",
"definition": "The policy(s) which constitute this insurance coverage.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Contract"
}
],
"mapping": [
{
"identity": "cpha3pharm",
"map": "C.35"
},
{
"identity": "v2",
"map": "IN1-16, 18, 19-name of insured, address, date of birth"
},
{
"identity": "cdanetv4",
"map": "D01 through D09"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DataElement",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DataElement",
"name": "DataElement",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DataElement Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "dex",
"uri": "http://wiki.ihe.net/index.php?title=Data_Element_Exchange",
"name": "IHE Data Element Exchange (DEX)"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "iso11179",
"uri": "http://metadata-standards.org/11179/",
"name": "ISO 11179"
},
{
"identity": "loincstruc",
"uri": "http://loinc.org/downloads",
"name": "LOINC Internal structure"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DataElement",
"short": "Resource data element",
"definition": "The formal description of a single piece of information that can be gathered and reported.",
"comments": "Often called a clinical template.",
"alias": [
"Master Observation",
"Data Element",
"CDE"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DataElement"
}
],
"mapping": [
{
"identity": "dex",
"map": "RetrieveMetadata response"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
}
]
},
{
"path": "DataElement.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DataElement.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DataElement.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DataElement.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DataElement.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DataElement.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.url",
"short": "Globally unique logical id for data element",
"definition": "An absolute uri that is used to identify this element when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./id[use=INSTANCE]"
}
]
},
{
"path": "DataElement.identifier",
"short": "Logical id to reference this data element",
"definition": "Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "id"
},
{
"identity": "v2",
"map": "OM1.2"
},
{
"identity": "rim",
"map": "./id[use=BUS]"
},
{
"identity": "loincstruc",
"map": "LOINC_NUM (the code is the identifier)"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier\n\nAs assigned by registering authority"
}
]
},
{
"path": "DataElement.version",
"short": "Logical id for this version of the data element",
"definition": "The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.",
"comments": "N/A.",
"requirements": "There may be multiple resource versions of the data element that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "version"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./id[use=VER]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier.version"
}
]
},
{
"path": "DataElement.name",
"short": "Descriptive label for this element definition",
"definition": "The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.",
"comments": "This may be similar to the question used to prompt someone for a data element value, but the purpose is communicating about the data element, not asking the question. (Refer to the 'question' element for the latter.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "displayName"
},
{
"identity": "v2",
"map": "OM1.11"
},
{
"identity": "rim",
"map": "./title"
},
{
"identity": "loincstruc",
"map": "LONG_COMMON_NAME"
},
{
"identity": "iso11179",
"map": "(Designatable_Item).designation.sign\n\nacceptability=preferred in default context"
}
]
},
{
"path": "DataElement.useContext",
"short": "Content intends to support these contexts",
"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 of data element definitions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM1.18, OM1.42, OM1.46, OM7.3"
},
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code"
},
{
"identity": "loincstruc",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
},
{
"identity": "iso11179",
"map": "(Classifiable_Item).classifier"
}
]
},
{
"path": "DataElement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search data elemnt definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search data element definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"experimental\"].value[type=BL]"
}
]
},
{
"path": "DataElement.status",
"short": "draft | active | retired",
"definition": "The status of the data element.",
"requirements": "Allows filtering of data elements that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "MFE.1"
},
{
"identity": "rim",
"map": "./status\n(draft = new\n active = active\n retired = aborted)"
},
{
"identity": "loincstruc",
"map": "STATUS"
},
{
"identity": "iso11179",
"map": "(Administered_item).registration.state\n\nnew = Incomplete, Candidate, Recorded, Qualified\n\nactive = Standard, Preferred Standard, Application\n\nretired = Retired, Superceded, Historical"
}
]
},
{
"path": "DataElement.date",
"short": "Date for this version of the data element",
"definition": "The date that the status for this business version of the data element became effective. (I.e. Date the draft was created, date element became active or date element became retired).",
"comments": "This refers to the \"business\" version - the DataElement.version which changes based on business processes. It does not refer to the date of the RESTful version which is part of the resource metadata.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "revisionDate"
},
{
"identity": "v2",
"map": "OM1.21"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/time"
},
{
"identity": "loincstruc",
"map": "DATE_LAST_CHANGED"
},
{
"identity": "iso11179",
"map": "(Administered_item).last_change_date"
}
]
},
{
"path": "DataElement.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.",
"comments": "The copyright statement does not apply to values for the data element, only to its definition.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=CONTRACT,moodCode=EVN].text"
}
]
},
{
"path": "DataElement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the data element.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the data element. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "registrationAuthority"
},
{
"identity": "v2",
"map": "OM1.16"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]/name"
},
{
"identity": "loincstruc",
"map": "Fixed to Regenstrief or SOURCE"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.name"
}
]
},
{
"path": "DataElement.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OM1.17"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.[email_address, phone_number, uri]"
}
]
},
{
"path": "DataElement.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the data element.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "DataElement.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "DataElement.specificity",
"short": "comparable | fully-specified | equivalent | convertable | scaleable | flexible",
"definition": "Identifies how precise the data element is in its definition.",
"requirements": "Allows determining whether the degree of comparability of data element instances - less granular data elements result in data that is less comparable (or at least requires more work to compare).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DataElementSpecificity",
"strength": "required",
"description": "Indicates the degree of precision of the data element definition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dataelement-specificity"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code=\"granularity\"]/value"
}
]
},
{
"path": "DataElement.mapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "dex",
"map": "100;0"
},
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.mapping.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.mapping.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comments",
"short": "Versions, Issues, Scope limitations etc",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.element",
"short": "Definition of element",
"definition": "Defines the structure, type, allowed values and other constraining characteristics of the data element.",
"comments": "For simple data types there will only be one repetion. For complex data types, multiple repetitions will be present defining a nested structure using the \"path\" element.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DataElement",
"short": "Resource data element",
"definition": "The formal description of a single piece of information that can be gathered and reported.",
"comments": "Often called a clinical template.",
"alias": [
"Master Observation",
"Data Element",
"CDE"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dex",
"map": "RetrieveMetadata response"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
}
]
},
{
"path": "DataElement.url",
"short": "Globally unique logical id for data element",
"definition": "An absolute uri that is used to identify this element when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./id[use=INSTANCE]"
}
]
},
{
"path": "DataElement.identifier",
"short": "Logical id to reference this data element",
"definition": "Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "id"
},
{
"identity": "v2",
"map": "OM1.2"
},
{
"identity": "rim",
"map": "./id[use=BUS]"
},
{
"identity": "loincstruc",
"map": "LOINC_NUM (the code is the identifier)"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier\n\nAs assigned by registering authority"
}
]
},
{
"path": "DataElement.version",
"short": "Logical id for this version of the data element",
"definition": "The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually.",
"comments": "N/A.",
"requirements": "There may be multiple resource versions of the data element that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "version"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./id[use=VER]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier.version"
}
]
},
{
"path": "DataElement.name",
"short": "Descriptive label for this element definition",
"definition": "The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used.",
"comments": "This may be similar to the question used to prompt someone for a data element value, but the purpose is communicating about the data element, not asking the question. (Refer to the 'question' element for the latter.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "displayName"
},
{
"identity": "v2",
"map": "OM1.11"
},
{
"identity": "rim",
"map": "./title"
},
{
"identity": "loincstruc",
"map": "LONG_COMMON_NAME"
},
{
"identity": "iso11179",
"map": "(Designatable_Item).designation.sign\n\nacceptability=preferred in default context"
}
]
},
{
"path": "DataElement.useContext",
"short": "Content intends to support these contexts",
"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 of data element definitions.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM1.18, OM1.42, OM1.46, OM7.3"
},
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code"
},
{
"identity": "loincstruc",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
},
{
"identity": "iso11179",
"map": "(Classifiable_Item).classifier"
}
]
},
{
"path": "DataElement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search data elemnt definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search data element definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"experimental\"].value[type=BL]"
}
]
},
{
"path": "DataElement.status",
"short": "draft | active | retired",
"definition": "The status of the data element.",
"requirements": "Allows filtering of data elements that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "MFE.1"
},
{
"identity": "rim",
"map": "./status\n(draft = new\n active = active\n retired = aborted)"
},
{
"identity": "loincstruc",
"map": "STATUS"
},
{
"identity": "iso11179",
"map": "(Administered_item).registration.state\n\nnew = Incomplete, Candidate, Recorded, Qualified\n\nactive = Standard, Preferred Standard, Application\n\nretired = Retired, Superceded, Historical"
}
]
},
{
"path": "DataElement.date",
"short": "Date for this version of the data element",
"definition": "The date that the status for this business version of the data element became effective. (I.e. Date the draft was created, date element became active or date element became retired).",
"comments": "This refers to the \"business\" version - the DataElement.version which changes based on business processes. It does not refer to the date of the RESTful version which is part of the resource metadata.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "revisionDate"
},
{
"identity": "v2",
"map": "OM1.21"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/time"
},
{
"identity": "loincstruc",
"map": "DATE_LAST_CHANGED"
},
{
"identity": "iso11179",
"map": "(Administered_item).last_change_date"
}
]
},
{
"path": "DataElement.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element.",
"comments": "The copyright statement does not apply to values for the data element, only to its definition.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=CONTRACT,moodCode=EVN].text"
}
]
},
{
"path": "DataElement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the data element.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the data element. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "registrationAuthority"
},
{
"identity": "v2",
"map": "OM1.16"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]/name"
},
{
"identity": "loincstruc",
"map": "Fixed to Regenstrief or SOURCE"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.name"
}
]
},
{
"path": "DataElement.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OM1.17"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.[email_address, phone_number, uri]"
}
]
},
{
"path": "DataElement.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the data element.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "DataElement.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "DataElement.specificity",
"short": "comparable | fully-specified | equivalent | convertable | scaleable | flexible",
"definition": "Identifies how precise the data element is in its definition.",
"requirements": "Allows determining whether the degree of comparability of data element instances - less granular data elements result in data that is less comparable (or at least requires more work to compare).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DataElementSpecificity",
"strength": "required",
"description": "Indicates the degree of precision of the data element definition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dataelement-specificity"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code=\"granularity\"]/value"
}
]
},
{
"path": "DataElement.mapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "dex",
"map": "100;0"
},
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comments",
"short": "Versions, Issues, Scope limitations etc",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.element",
"short": "Definition of element",
"definition": "Defines the structure, type, allowed values and other constraining characteristics of the data element.",
"comments": "For simple data types there will only be one repetion. For complex data types, multiple repetitions will be present defining a nested structure using the \"path\" element.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Device",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Device",
"name": "Device",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Device Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Device",
"short": "An instance of a manufactured thing that is used in the provision of healthcare",
"definition": "This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"requirements": "Allows institutions to track their devices.",
"min": 1,
"max": "1",
"type": [
{
"code": "Device"
}
],
"mapping": [
{
"identity": "rim",
"map": "Device"
}
]
},
{
"path": "Device.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Device.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Device.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Device.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Device.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Device.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Device.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Device.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Device.identifier",
"short": "Instance id from manufacturer, owner, and others",
"definition": "Unique instance identifiers assigned to a device by organizations like manufacturers or owners . If the identifier identifies the type of device, Device.type should be used.",
"comments": "Often fixed to the device as a barcode and may include names given to the device in local usage. Note that some of the barcodes affixed to the device identify its type, not its instance. For the FDA Mandated Unique Device Identifier (UDI) use the Device.udi element.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Device.type",
"short": "What kind of device this is",
"definition": "Code or identifier to identify a kind of device.",
"comments": "For the FDA Mandated Unique Device Identifier (UDI) use the Device.udi element.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DeviceKind",
"strength": "example",
"description": "Defines the nature of the device and the kind of functionality/services/behavior that may be expected from it",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!rosetta"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Device.status",
"short": "available | not-available | entered-in-error",
"definition": "Status of the Device availability.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DeviceStatus",
"strength": "required",
"description": "The availability status of the device",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/devicestatus"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Device.manufacturer",
"short": "Name of device manufacturer",
"definition": "A name of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].scoper.name"
}
]
},
{
"path": "Device.model",
"short": "Model id assigned by the manufacturer",
"definition": "The \"model\" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].code"
}
]
},
{
"path": "Device.version",
"short": "Version number (i.e. software)",
"definition": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".softwareName (included as part)"
}
]
},
{
"path": "Device.manufactureDate",
"short": "Manufacture date",
"definition": "The Date and time when the device was manufactured.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Device.expiry",
"short": "Date and time of expiry of this device (if applicable)",
"definition": "The date and time beyond which this device is no longer valid or should not be used (if applicable).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".expirationTime"
}
]
},
{
"path": "Device.udi",
"short": "FDA Mandated Unique Device Identifier",
"definition": "United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.",
"comments": "The unique identifier may identify an instance of a device uniquely, or it may just identify the type of the device. A portion of the UDI - the DI part - can be extracted from the UDI when required, and used to look up information about the device through the GUDID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id[where root is root for UDI]"
}
]
},
{
"path": "Device.lotNumber",
"short": "Lot number of manufacture",
"definition": "Lot number assigned by the manufacturer.",
"comments": "Alphanumeric Maximum 20.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".lotNumberText"
}
]
},
{
"path": "Device.owner",
"short": "Organization responsible for device",
"definition": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=OWN].scoper"
}
]
},
{
"path": "Device.location",
"short": "Where the resource is found",
"definition": "The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. \"in/with the patient\"), or a coded location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=LOCE].scoper"
}
]
},
{
"path": "Device.patient",
"short": "If the resource is affixed to a person",
"definition": "Patient information, if the resource is affixed to a person.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
}
]
},
{
"path": "Device.contact",
"short": "Details for human/organization for support",
"definition": "Contact details for an organization or a particular human that is responsible for the device.",
"comments": "used for troubleshooting etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[typeCode=CON].player"
}
]
},
{
"path": "Device.url",
"short": "Network address to contact device",
"definition": "A network address on which the device may be contacted directly.",
"comments": "If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Device",
"short": "An instance of a manufactured thing that is used in the provision of healthcare",
"definition": "This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health.",
"requirements": "Allows institutions to track their devices.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Device"
}
]
},
{
"path": "Device.identifier",
"short": "Instance id from manufacturer, owner, and others",
"definition": "Unique instance identifiers assigned to a device by organizations like manufacturers or owners . If the identifier identifies the type of device, Device.type should be used.",
"comments": "Often fixed to the device as a barcode and may include names given to the device in local usage. Note that some of the barcodes affixed to the device identify its type, not its instance. For the FDA Mandated Unique Device Identifier (UDI) use the Device.udi element.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Device.type",
"short": "What kind of device this is",
"definition": "Code or identifier to identify a kind of device.",
"comments": "For the FDA Mandated Unique Device Identifier (UDI) use the Device.udi element.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DeviceKind",
"strength": "example",
"description": "Defines the nature of the device and the kind of functionality/services/behavior that may be expected from it",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!rosetta"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Device.status",
"short": "available | not-available | entered-in-error",
"definition": "Status of the Device availability.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DeviceStatus",
"strength": "required",
"description": "The availability status of the device",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/devicestatus"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Device.manufacturer",
"short": "Name of device manufacturer",
"definition": "A name of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].scoper.name"
}
]
},
{
"path": "Device.model",
"short": "Model id assigned by the manufacturer",
"definition": "The \"model\" - an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=MANU].code"
}
]
},
{
"path": "Device.version",
"short": "Version number (i.e. software)",
"definition": "The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".softwareName (included as part)"
}
]
},
{
"path": "Device.manufactureDate",
"short": "Manufacture date",
"definition": "The Date and time when the device was manufactured.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Device.expiry",
"short": "Date and time of expiry of this device (if applicable)",
"definition": "The date and time beyond which this device is no longer valid or should not be used (if applicable).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".expirationTime"
}
]
},
{
"path": "Device.udi",
"short": "FDA Mandated Unique Device Identifier",
"definition": "United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm.",
"comments": "The unique identifier may identify an instance of a device uniquely, or it may just identify the type of the device. A portion of the UDI - the DI part - can be extracted from the UDI when required, and used to look up information about the device through the GUDID.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id[where root is root for UDI]"
}
]
},
{
"path": "Device.lotNumber",
"short": "Lot number of manufacture",
"definition": "Lot number assigned by the manufacturer.",
"comments": "Alphanumeric Maximum 20.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".lotNumberText"
}
]
},
{
"path": "Device.owner",
"short": "Organization responsible for device",
"definition": "An organization that is responsible for the provision and ongoing maintenance of the device.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=OWN].scoper"
}
]
},
{
"path": "Device.location",
"short": "Where the resource is found",
"definition": "The resource may be found in a literal location (i.e. GPS coordinates), a logical place (i.e. \"in/with the patient\"), or a coded location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=LOCE].scoper"
}
]
},
{
"path": "Device.patient",
"short": "If the resource is affixed to a person",
"definition": "Patient information, if the resource is affixed to a person.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".playedRole[typeCode=USED].scoper.playedRole[typeCode=PAT]"
}
]
},
{
"path": "Device.contact",
"short": "Details for human/organization for support",
"definition": "Contact details for an organization or a particular human that is responsible for the device.",
"comments": "used for troubleshooting etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[typeCode=CON].player"
}
]
},
{
"path": "Device.url",
"short": "Network address to contact device",
"definition": "A network address on which the device may be contacted directly.",
"comments": "If the device is running a FHIR server, the network address should be the root URL from which a conformance statement may be retrieved.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DeviceComponent",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DeviceComponent",
"name": "DeviceComponent",
"publisher": "HL7 FHIR Project (Healthcare Devices)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DeviceComponent Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DeviceComponent",
"short": "An instance of a medical-related component of a medical device",
"definition": "Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.",
"min": 1,
"max": "1",
"type": [
{
"code": "DeviceComponent"
}
]
},
{
"path": "DeviceComponent.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DeviceComponent.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DeviceComponent.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DeviceComponent.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DeviceComponent.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DeviceComponent.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceComponent.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceComponent.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceComponent.type",
"short": "What kind of component it is",
"definition": "Describes the specific component type as defined in the object-oriented or metric nomenclature partition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ComponentType",
"strength": "required",
"description": "Describes the type of the component",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
}
},
{
"path": "DeviceComponent.identifier",
"short": "Instance id assigned by the software stack",
"definition": "Describes the local assigned unique identification by the software. For example: handle ID.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceComponent.lastSystemChange",
"short": "Recent system change timestamp",
"definition": "Describes the timestamp for the most recent system change which includes device configuration or setting change.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "DeviceComponent.source",
"short": "A source device of this component",
"definition": "Describes the link to the source Device that contains administrative device information such as manufacture, serial number, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
},
{
"path": "DeviceComponent.parent",
"short": "Parent resource link",
"definition": "Describes the link to the parent resource. For example: Channel is linked to its VMD parent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
}
]
},
{
"path": "DeviceComponent.operationalStatus",
"short": "Component operational status",
"definition": "Indicates current operational status of the device. For example: On, Off, Standby, etc.",
"comments": "OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that is defined in its profile.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.parameterGroup",
"short": "Current supported parameter group",
"definition": "Describes the parameter group supported by the current device component that is based on some nomenclature, e.g., cardiovascular.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.measurementPrinciple",
"short": "other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+",
"definition": "Describes the physical principle of the measurement. For example: thermal, chemical, acoustical, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Measmnt-Principle",
"strength": "required",
"description": "Different measurement principle supported by the device",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/measurement-principle"
}
}
},
{
"path": "DeviceComponent.productionSpecification",
"short": "Production specification of the component",
"definition": "Describes the production specification such as component revision, serial number, etc.",
"min": 0,
"max": "*"
},
{
"path": "DeviceComponent.productionSpecification.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DeviceComponent.productionSpecification.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DeviceComponent.productionSpecification.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceComponent.productionSpecification.specType",
"short": "Specification type",
"definition": "Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.productionSpecification.componentId",
"short": "Internal component unique identification",
"definition": "Describes the internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacture can make use of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceComponent.productionSpecification.productionSpec",
"short": "A printable string defining the component",
"definition": "Describes the printable string defining the component.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "DeviceComponent.languageCode",
"short": "Language code for the human-readable text strings produced by the device",
"definition": "Describes the language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DeviceComponent",
"short": "An instance of a medical-related component of a medical device",
"definition": "Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "DeviceComponent.type",
"short": "What kind of component it is",
"definition": "Describes the specific component type as defined in the object-oriented or metric nomenclature partition.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ComponentType",
"strength": "required",
"description": "Describes the type of the component",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
}
},
{
"path": "DeviceComponent.identifier",
"short": "Instance id assigned by the software stack",
"definition": "Describes the local assigned unique identification by the software. For example: handle ID.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceComponent.lastSystemChange",
"short": "Recent system change timestamp",
"definition": "Describes the timestamp for the most recent system change which includes device configuration or setting change.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "DeviceComponent.source",
"short": "A source device of this component",
"definition": "Describes the link to the source Device that contains administrative device information such as manufacture, serial number, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
},
{
"path": "DeviceComponent.parent",
"short": "Parent resource link",
"definition": "Describes the link to the parent resource. For example: Channel is linked to its VMD parent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
}
]
},
{
"path": "DeviceComponent.operationalStatus",
"short": "Component operational status",
"definition": "Indicates current operational status of the device. For example: On, Off, Standby, etc.",
"comments": "OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that is defined in its profile.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.parameterGroup",
"short": "Current supported parameter group",
"definition": "Describes the parameter group supported by the current device component that is based on some nomenclature, e.g., cardiovascular.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.measurementPrinciple",
"short": "other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+",
"definition": "Describes the physical principle of the measurement. For example: thermal, chemical, acoustical, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Measmnt-Principle",
"strength": "required",
"description": "Different measurement principle supported by the device",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/measurement-principle"
}
}
},
{
"path": "DeviceComponent.productionSpecification",
"short": "Production specification of the component",
"definition": "Describes the production specification such as component revision, serial number, etc.",
"min": 0,
"max": "*"
},
{
"path": "DeviceComponent.productionSpecification.specType",
"short": "Specification type",
"definition": "Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "DeviceComponent.productionSpecification.componentId",
"short": "Internal component unique identification",
"definition": "Describes the internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacture can make use of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceComponent.productionSpecification.productionSpec",
"short": "A printable string defining the component",
"definition": "Describes the printable string defining the component.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "DeviceComponent.languageCode",
"short": "Language code for the human-readable text strings produced by the device",
"definition": "Describes the language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DeviceMetric",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DeviceMetric",
"name": "DeviceMetric",
"publisher": "HL7 FHIR Project (Health Care Devices)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DeviceMetric Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DeviceMetric",
"short": "Measurement, calculation or setting capability of a medical device",
"definition": "Describes a measurement, calculation or setting capability of a medical device.",
"min": 1,
"max": "1",
"type": [
{
"code": "DeviceMetric"
}
]
},
{
"path": "DeviceMetric.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DeviceMetric.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DeviceMetric.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DeviceMetric.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DeviceMetric.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DeviceMetric.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceMetric.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceMetric.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceMetric.type",
"short": "Type of metric",
"definition": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MetricType",
"strength": "required",
"description": "Describes the metric type",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
}
},
{
"path": "DeviceMetric.identifier",
"short": "Unique identifier of this DeviceMetric",
"definition": "Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. \nIt should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceMetric.unit",
"short": "Unit of metric",
"definition": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MetricUnit",
"strength": "required",
"description": "Describes the unit of the metric",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!units"
}
},
{
"path": "DeviceMetric.source",
"short": "Describes the link to the source Device",
"definition": "Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
},
{
"path": "DeviceMetric.parent",
"short": "Describes the link to the parent DeviceComponent",
"definition": "Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device.\nAn example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
}
]
},
{
"path": "DeviceMetric.operationalStatus",
"short": "on | off | standby",
"definition": "Indicates current operational state of the device. For example: On, Off, Standby, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricOperationalStatus",
"strength": "required",
"description": "Describes the operational status of the DeviceMetric",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-operational-status"
}
}
},
{
"path": "DeviceMetric.color",
"short": "black | red | green | yellow | blue | magenta | cyan | white",
"definition": "Describes the typical color of the representation of observations that have been generated for this DeviceMetric.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricColor",
"strength": "required",
"description": "Describes the typical color of representation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-color"
}
}
},
{
"path": "DeviceMetric.category",
"short": "measurement | setting | calculation | unspecified",
"definition": "Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCategory",
"strength": "required",
"description": "Describes the category of the metric",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-category"
}
}
},
{
"path": "DeviceMetric.measurementPeriod",
"short": "Describes the measurement repetition time",
"definition": "Describes the measurement repetition time. This is not\nnecessarily the same as the update\nperiod.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
]
},
{
"path": "DeviceMetric.calibration",
"short": "Describes the calibrations that have been performed or that are required to be performed",
"definition": "Describes the calibrations that have been performed or that are required to be performed.",
"min": 0,
"max": "*"
},
{
"path": "DeviceMetric.calibration.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DeviceMetric.calibration.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DeviceMetric.calibration.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceMetric.calibration.type",
"short": "unspecified | offset | gain | two-point",
"definition": "Describes the type of the calibration method.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCalibrationType",
"strength": "required",
"description": "Describes the type of a metric calibration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-calibration-type"
}
}
},
{
"path": "DeviceMetric.calibration.state",
"short": "not-calibrated | calibration-required | calibrated | unspecified",
"definition": "Describes the state of the calibration.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCalibrationState",
"strength": "required",
"description": "Describes the state of a metric calibration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-calibration-state"
}
}
},
{
"path": "DeviceMetric.calibration.time",
"short": "Describes the time last calibration has been performed",
"definition": "Describes the time last calibration has been performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DeviceMetric",
"short": "Measurement, calculation or setting capability of a medical device",
"definition": "Describes a measurement, calculation or setting capability of a medical device.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "DeviceMetric.type",
"short": "Type of metric",
"definition": "Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MetricType",
"strength": "required",
"description": "Describes the metric type",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
}
},
{
"path": "DeviceMetric.identifier",
"short": "Unique identifier of this DeviceMetric",
"definition": "Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. \nIt should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DeviceMetric.unit",
"short": "Unit of metric",
"definition": "Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MetricUnit",
"strength": "required",
"description": "Describes the unit of the metric",
"valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!units"
}
},
{
"path": "DeviceMetric.source",
"short": "Describes the link to the source Device",
"definition": "Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacture, serial number, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
},
{
"path": "DeviceMetric.parent",
"short": "Describes the link to the parent DeviceComponent",
"definition": "Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device.\nAn example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
}
]
},
{
"path": "DeviceMetric.operationalStatus",
"short": "on | off | standby",
"definition": "Indicates current operational state of the device. For example: On, Off, Standby, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricOperationalStatus",
"strength": "required",
"description": "Describes the operational status of the DeviceMetric",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-operational-status"
}
}
},
{
"path": "DeviceMetric.color",
"short": "black | red | green | yellow | blue | magenta | cyan | white",
"definition": "Describes the typical color of the representation of observations that have been generated for this DeviceMetric.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricColor",
"strength": "required",
"description": "Describes the typical color of representation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-color"
}
}
},
{
"path": "DeviceMetric.category",
"short": "measurement | setting | calculation | unspecified",
"definition": "Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCategory",
"strength": "required",
"description": "Describes the category of the metric",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-category"
}
}
},
{
"path": "DeviceMetric.measurementPeriod",
"short": "Describes the measurement repetition time",
"definition": "Describes the measurement repetition time. This is not\nnecessarily the same as the update\nperiod.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
]
},
{
"path": "DeviceMetric.calibration",
"short": "Describes the calibrations that have been performed or that are required to be performed",
"definition": "Describes the calibrations that have been performed or that are required to be performed.",
"min": 0,
"max": "*"
},
{
"path": "DeviceMetric.calibration.type",
"short": "unspecified | offset | gain | two-point",
"definition": "Describes the type of the calibration method.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCalibrationType",
"strength": "required",
"description": "Describes the type of a metric calibration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-calibration-type"
}
}
},
{
"path": "DeviceMetric.calibration.state",
"short": "not-calibrated | calibration-required | calibrated | unspecified",
"definition": "Describes the state of the calibration.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceMetricCalibrationState",
"strength": "required",
"description": "Describes the state of a metric calibration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/metric-calibration-state"
}
}
},
{
"path": "DeviceMetric.calibration.time",
"short": "Describes the time last calibration has been performed",
"definition": "Describes the time last calibration has been performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DeviceUseRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DeviceUseRequest",
"name": "DeviceUseRequest",
"publisher": "HL7 FHIR Project (Health Care Devices)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DeviceUseRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "quick",
"uri": "http://wiki.siframework.org/CQF",
"name": "Quality Improvement and Clinical Knowledge (QUICK)"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DeviceUseRequest",
"short": "A request for a patient to use or be given a medical device",
"definition": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.",
"min": 1,
"max": "1",
"type": [
{
"code": "DeviceUseRequest"
}
]
},
{
"path": "DeviceUseRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DeviceUseRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DeviceUseRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DeviceUseRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DeviceUseRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DeviceUseRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseRequest.bodySite[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the device should be used ( i.e. the target site).",
"requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DeviceUseRequest.status",
"short": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | aborted",
"definition": "The status of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DeviceUseRequestStatus",
"strength": "required",
"description": "Codes representing the status of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-use-request-status"
}
},
"mapping": [
{
"identity": "quick",
"map": "Action.currentStatus"
}
]
},
{
"path": "DeviceUseRequest.device",
"short": "Device requested",
"definition": "The details of the device to be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.device"
}
]
},
{
"path": "DeviceUseRequest.encounter",
"short": "Encounter motivating request",
"definition": "An encounter that provides additional context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.encounter"
}
]
},
{
"path": "DeviceUseRequest.identifier",
"short": "Request identifier",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "DeviceUseRequest.indication",
"short": "Reason for request",
"definition": "Reason or justification for the use of this device.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "DeviceUseRequest.notes",
"short": "Notes or comments",
"definition": "Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "DeviceUseRequest.prnReason",
"short": "PRN",
"definition": "The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.prnReason.reason"
}
]
},
{
"path": "DeviceUseRequest.orderedOn",
"short": "When ordered",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.proposedAtTime"
}
]
},
{
"path": "DeviceUseRequest.recordedOn",
"short": "When recorded",
"definition": "The time at which the request was made/recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementDateTime"
}
]
},
{
"path": "DeviceUseRequest.subject",
"short": "Focus of request",
"definition": "The patient who will use the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "DeviceUseRequest.timing[x]",
"short": "Schedule for use",
"definition": "The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.applicationSchedule"
}
]
},
{
"path": "DeviceUseRequest.priority",
"short": "routine | urgent | stat | asap",
"definition": "Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceUseRequestPriority",
"strength": "required",
"description": "Codes representing the priority of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-use-request-priority"
}
},
"mapping": [
{
"identity": "quick",
"map": "Proposal.urgency"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DeviceUseRequest",
"short": "A request for a patient to use or be given a medical device",
"definition": "Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "DeviceUseRequest.bodySite[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the device should be used ( i.e. the target site).",
"requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DeviceUseRequest.status",
"short": "proposed | planned | requested | received | accepted | in-progress | completed | suspended | rejected | aborted",
"definition": "The status of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DeviceUseRequestStatus",
"strength": "required",
"description": "Codes representing the status of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-use-request-status"
}
},
"mapping": [
{
"identity": "quick",
"map": "Action.currentStatus"
}
]
},
{
"path": "DeviceUseRequest.device",
"short": "Device requested",
"definition": "The details of the device to be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.device"
}
]
},
{
"path": "DeviceUseRequest.encounter",
"short": "Encounter motivating request",
"definition": "An encounter that provides additional context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.encounter"
}
]
},
{
"path": "DeviceUseRequest.identifier",
"short": "Request identifier",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "DeviceUseRequest.indication",
"short": "Reason for request",
"definition": "Reason or justification for the use of this device.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "DeviceUseRequest.notes",
"short": "Notes or comments",
"definition": "Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "DeviceUseRequest.prnReason",
"short": "PRN",
"definition": "The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.prnReason.reason"
}
]
},
{
"path": "DeviceUseRequest.orderedOn",
"short": "When ordered",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.proposedAtTime"
}
]
},
{
"path": "DeviceUseRequest.recordedOn",
"short": "When recorded",
"definition": "The time at which the request was made/recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementDateTime"
}
]
},
{
"path": "DeviceUseRequest.subject",
"short": "Focus of request",
"definition": "The patient who will use the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "DeviceUseRequest.timing[x]",
"short": "Schedule for use",
"definition": "The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.applicationSchedule"
}
]
},
{
"path": "DeviceUseRequest.priority",
"short": "routine | urgent | stat | asap",
"definition": "Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DeviceUseRequestPriority",
"strength": "required",
"description": "Codes representing the priority of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-use-request-priority"
}
},
"mapping": [
{
"identity": "quick",
"map": "Proposal.urgency"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DeviceUseStatement",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DeviceUseStatement",
"name": "DeviceUseStatement",
"publisher": "HL7 FHIR Project (Health Care Devices)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DeviceUseStatement Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "quick",
"uri": "http://wiki.siframework.org/CQF",
"name": "Quality Improvement and Clinical Knowledge (QUICK)"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DeviceUseStatement",
"short": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.",
"definition": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.",
"min": 1,
"max": "1",
"type": [
{
"code": "DeviceUseStatement"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUsePerformanceOccurrence"
}
]
},
{
"path": "DeviceUseStatement.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DeviceUseStatement.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DeviceUseStatement.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DeviceUseStatement.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DeviceUseStatement.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DeviceUseStatement.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseStatement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseStatement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DeviceUseStatement.bodySite[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the device was used ( i.e. the target site).",
"requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DeviceUseStatement.whenUsed",
"short": "The time period over which the device was used.",
"definition": "The time period over which the device was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "quick",
"map": "Performance.performanceTime"
}
]
},
{
"path": "DeviceUseStatement.device",
"short": "The details of the device used.",
"definition": "The details of the device used.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.device"
}
]
},
{
"path": "DeviceUseStatement.identifier",
"short": "An external identifier for this statement such as an IRI.",
"definition": "An external identifier for this statement such as an IRI.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "DeviceUseStatement.indication",
"short": "Reason or justification for the use of the device.",
"definition": "Reason or justification for the use of the device.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "DeviceUseStatement.notes",
"short": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"definition": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "DeviceUseStatement.recordedOn",
"short": "The time at which the statement was made/recorded.",
"definition": "The time at which the statement was made/recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementDateTime"
}
]
},
{
"path": "DeviceUseStatement.subject",
"short": "The patient who used the device.",
"definition": "The patient who used the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "DeviceUseStatement.timing[x]",
"short": "How often the device was used.",
"definition": "How often the device was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.applicationSchedule"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DeviceUseStatement",
"short": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.",
"definition": "A record of a device being used by a patient where the record is the result of a report from the patient or another clinician.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUsePerformanceOccurrence"
}
]
},
{
"path": "DeviceUseStatement.bodySite[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the device was used ( i.e. the target site).",
"requirements": "Knowing where the device is targeted is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DeviceUseStatement.whenUsed",
"short": "The time period over which the device was used.",
"definition": "The time period over which the device was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "quick",
"map": "Performance.performanceTime"
}
]
},
{
"path": "DeviceUseStatement.device",
"short": "The details of the device used.",
"definition": "The details of the device used.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.device"
}
]
},
{
"path": "DeviceUseStatement.identifier",
"short": "An external identifier for this statement such as an IRI.",
"definition": "An external identifier for this statement such as an IRI.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "DeviceUseStatement.indication",
"short": "Reason or justification for the use of the device.",
"definition": "Reason or justification for the use of the device.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "DeviceUseStatement.notes",
"short": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"definition": "Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "DeviceUseStatement.recordedOn",
"short": "The time at which the statement was made/recorded.",
"definition": "The time at which the statement was made/recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementDateTime"
}
]
},
{
"path": "DeviceUseStatement.subject",
"short": "The patient who used the device.",
"definition": "The patient who used the device.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "DeviceUseStatement.timing[x]",
"short": "How often the device was used.",
"definition": "How often the device was used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "DeviceUse.applicationSchedule"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DiagnosticOrder",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder",
"name": "DiagnosticOrder",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DiagnosticOrder Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DiagnosticOrder",
"short": "A request for a diagnostic service",
"definition": "A record of a request for a diagnostic investigation service to be performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=RQO, code<\"diagnostic order\"]"
}
]
},
{
"path": "DiagnosticOrder.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DiagnosticOrder.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DiagnosticOrder.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DiagnosticOrder.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DiagnosticOrder.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DiagnosticOrder.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticOrder.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticOrder.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticOrder.subject",
"short": "Who and/or what test is about",
"definition": "Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "DiagnosticOrder.orderer",
"short": "Who ordered the test",
"definition": "The practitioner that holds legal responsibility for ordering the investigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "DiagnosticOrder.identifier",
"short": "Identifiers assigned to this order",
"definition": "Identifiers assigned to this order by the order or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "DiagnosticOrder.encounter",
"short": "The encounter that this diagnostic order is associated with",
"definition": "An encounter that provides additional information about the healthcare context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticOrder.clinicalNotes",
"short": "Explanation/Justification for test",
"definition": "An explanation or justification for why this diagnostic investigation is being requested.",
"comments": "This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.originalText"
}
]
},
{
"path": "DiagnosticOrder.supportingInformation",
"short": "Additional clinical information",
"definition": "Additional clinical information about the patient or specimen that may influence test interpretations.",
"comments": "This information includes diagnosis, clinical findings and other observations. Examples include reporting the amount of inspired carbon dioxide for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-13"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=SPRT]/target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticOrder.specimen",
"short": "If the whole order relates to specific specimens",
"definition": "One or more specimens that the diagnostic investigation is about.",
"comments": "Many investigation requests will create a need for specimens, but the request itself is not actually about the specimens. This is provided for when the diagnostic investigation is requested on already existing specimens.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
},
{
"path": "DiagnosticOrder.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status of the order.",
"comments": "Typically the system placing the order sets the status to requested. Thereafter, the order is maintained by the receiver that updates the status as the request is handled.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.priority",
"short": "routine | urgent | stat | asap",
"definition": "The clinical priority associated with this order.",
"comments": "The Order resource also has a priority. Generally, these should be the same, but they can be different, for instance in the case where the clinician indicates that the order is urgent, but the subsequent workflow process overrule this priority for some reason. The effective default value is \"normal\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderPriority",
"strength": "required",
"description": "The clinical priority of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-priority"
}
},
"mapping": [
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "DiagnosticOrder.event",
"name": "event",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed.",
"comments": "This is not the same as an audit trail - it is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"path": "DiagnosticOrder.event.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticOrder.event.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticOrder.event.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticOrder.event.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status for the event.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.event.description",
"short": "More information about the event and its context",
"definition": "Additional information about the event that occurred - e.g. if the status remained unchanged.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderEventDescription",
"strength": "example",
"description": "Additional information about an event that occurred to a diagnostic order - e.g. if the status remained unchanged",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-event"
}
},
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "DiagnosticOrder.event.dateTime",
"short": "The date at which the event happened",
"definition": "The date/time at which the event occurred.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "DiagnosticOrder.event.actor",
"short": "Who recorded or did this",
"definition": "The person who was responsible for performing or recording the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[AUT or PFM]"
}
]
},
{
"path": "DiagnosticOrder.item",
"short": "The items the orderer requested",
"definition": "The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.",
"comments": "There would always be at least one item in normal usage, but this is optional so that a workflow can quote order details without having to list the items.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=OBS]"
}
]
},
{
"path": "DiagnosticOrder.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticOrder.item.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticOrder.item.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticOrder.item.code",
"short": "Code to indicate the item (test or panel) being ordered",
"definition": "A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.",
"comments": "Many laboratory tests and radiology tests embed the specimen/organ system in the test name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticRequests",
"strength": "required",
"description": "Codes for tests/services that can be performed by diagnostic services",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-requests"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DiagnosticOrder.item.specimen",
"short": "If this item relates to specific specimens",
"definition": "If the item is related to a specific specimen.",
"comments": "A single specimen should not appear in both DiagnosticOrder.specimen and DiagnosticOrder.item.specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
},
{
"path": "DiagnosticOrder.item.bodySite[x]",
"short": "Location of requested test (if applicable)",
"definition": "Anatomical location where the request test should be performed. This is the target site.",
"alias": [
"location"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DiagnosticOrder.item.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status of this individual item within the order.",
"comments": "If the request has multiple items that have their own life cycles, then the items will have their own status while the overall diagnostic order is (usually) \"in-progress\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.item.event",
"short": "Events specific to this item",
"definition": "A summary of the events of interest that have occurred as this item of the request is processed.",
"min": 0,
"max": "*",
"nameReference": "event",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DiagnosticOrder",
"short": "A request for a diagnostic service",
"definition": "A record of a request for a diagnostic investigation service to be performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=RQO, code<\"diagnostic order\"]"
}
]
},
{
"path": "DiagnosticOrder.subject",
"short": "Who and/or what test is about",
"definition": "Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "DiagnosticOrder.orderer",
"short": "Who ordered the test",
"definition": "The practitioner that holds legal responsibility for ordering the investigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "DiagnosticOrder.identifier",
"short": "Identifiers assigned to this order",
"definition": "Identifiers assigned to this order by the order or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "DiagnosticOrder.encounter",
"short": "The encounter that this diagnostic order is associated with",
"definition": "An encounter that provides additional information about the healthcare context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticOrder.clinicalNotes",
"short": "Explanation/Justification for test",
"definition": "An explanation or justification for why this diagnostic investigation is being requested.",
"comments": "This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.originalText"
}
]
},
{
"path": "DiagnosticOrder.supportingInformation",
"short": "Additional clinical information",
"definition": "Additional clinical information about the patient or specimen that may influence test interpretations.",
"comments": "This information includes diagnosis, clinical findings and other observations. Examples include reporting the amount of inspired carbon dioxide for blood gasses, the point in the menstrual cycle for cervical pap tests, and other conditions that influence test interpretations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-13"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=SPRT]/target[classCode=ACT, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticOrder.specimen",
"short": "If the whole order relates to specific specimens",
"definition": "One or more specimens that the diagnostic investigation is about.",
"comments": "Many investigation requests will create a need for specimens, but the request itself is not actually about the specimens. This is provided for when the diagnostic investigation is requested on already existing specimens.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
},
{
"path": "DiagnosticOrder.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status of the order.",
"comments": "Typically the system placing the order sets the status to requested. Thereafter, the order is maintained by the receiver that updates the status as the request is handled.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.priority",
"short": "routine | urgent | stat | asap",
"definition": "The clinical priority associated with this order.",
"comments": "The Order resource also has a priority. Generally, these should be the same, but they can be different, for instance in the case where the clinician indicates that the order is urgent, but the subsequent workflow process overrule this priority for some reason. The effective default value is \"normal\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderPriority",
"strength": "required",
"description": "The clinical priority of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-priority"
}
},
"mapping": [
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "DiagnosticOrder.event",
"name": "event",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred as the request is processed. E.g. when the order was made, various processing steps (specimens received), when it was completed.",
"comments": "This is not the same as an audit trail - it is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"path": "DiagnosticOrder.event.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status for the event.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.event.description",
"short": "More information about the event and its context",
"definition": "Additional information about the event that occurred - e.g. if the status remained unchanged.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderEventDescription",
"strength": "example",
"description": "Additional information about an event that occurred to a diagnostic order - e.g. if the status remained unchanged",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-event"
}
},
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "DiagnosticOrder.event.dateTime",
"short": "The date at which the event happened",
"definition": "The date/time at which the event occurred.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "DiagnosticOrder.event.actor",
"short": "Who recorded or did this",
"definition": "The person who was responsible for performing or recording the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[AUT or PFM]"
}
]
},
{
"path": "DiagnosticOrder.item",
"short": "The items the orderer requested",
"definition": "The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.",
"comments": "There would always be at least one item in normal usage, but this is optional so that a workflow can quote order details without having to list the items.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=OBS]"
}
]
},
{
"path": "DiagnosticOrder.item.code",
"short": "Code to indicate the item (test or panel) being ordered",
"definition": "A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested.",
"comments": "Many laboratory tests and radiology tests embed the specimen/organ system in the test name, for example, serum or serum/plasma glucose, or a chest xray. The specimen may not be recorded separately from the test code.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticRequests",
"strength": "required",
"description": "Codes for tests/services that can be performed by diagnostic services",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-requests"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DiagnosticOrder.item.specimen",
"short": "If this item relates to specific specimens",
"definition": "If the item is related to a specific specimen.",
"comments": "A single specimen should not appear in both DiagnosticOrder.specimen and DiagnosticOrder.item.specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SPC].role"
}
]
},
{
"path": "DiagnosticOrder.item.bodySite[x]",
"short": "Location of requested test (if applicable)",
"definition": "Anatomical location where the request test should be performed. This is the target site.",
"alias": [
"location"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "DiagnosticOrder.item.status",
"short": "proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed",
"definition": "The status of this individual item within the order.",
"comments": "If the request has multiple items that have their own life cycles, then the items will have their own status while the overall diagnostic order is (usually) \"in-progress\".",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticOrderStatus",
"strength": "required",
"description": "The status of a diagnostic order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-order-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode\ralso influenced by whether a ControlAct fulfillment requeste exists, whether a promise exists, status of the review component, whether a fulfilling observation exists, whether a refusal exists"
}
]
},
{
"path": "DiagnosticOrder.item.event",
"short": "Events specific to this item",
"definition": "A summary of the events of interest that have occurred as this item of the request is processed.",
"min": 0,
"max": "*",
"nameReference": "event",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DiagnosticReport",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport",
"name": "DiagnosticReport",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DiagnosticReport Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DiagnosticReport",
"short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports",
"definition": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.",
"comments": "This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.",
"requirements": "To support reporting for any diagnostic report into a clinical data repository.",
"alias": [
"Report",
"Test",
"Result",
"Results",
"Labs",
"Laboratory"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DiagnosticReport"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DiagnosticReport.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DiagnosticReport.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DiagnosticReport.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DiagnosticReport.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DiagnosticReport.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticReport.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticReport.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticReport.name",
"short": "Name/Code for this diagnostic report",
"definition": "A code or name that describes this diagnostic report.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticReportNames",
"strength": "required",
"description": "Codes that describe Diagnostic Reports",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/report-names"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4-Universal Service ID (V2 doesn't provide an easy way to indicate both the ordered test and the performed panel)"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "DiagnosticReport.status",
"short": "registered | partial | final | corrected | appended | cancelled | entered-in-error",
"definition": "The status of the diagnostic report as a whole.",
"comments": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
"requirements": "Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DiagnosticReportStatus",
"strength": "required",
"description": "The status of the diagnostic report as a whole",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-report-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-25-Result Status (not 1:1 mapping)"
},
{
"identity": "rim",
"map": "statusCode\n\nNote: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\""
}
]
},
{
"path": "DiagnosticReport.issued",
"short": "Date this version was released",
"definition": "The date and/or time that this version of the report was released from the source diagnostic service.",
"comments": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report .",
"requirements": "Clinicians need to be able to check the date that the report was released.",
"alias": [
"Date Created",
"Date published",
"Date Issued"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-22-Results Rpt/Status Chng - Date/Time"
},
{
"identity": "rim",
"map": "participation[typeCode=VRF or AUT].time"
}
]
},
{
"path": "DiagnosticReport.subject",
"short": "The subject of the report, usually, but not always, the patient",
"definition": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.",
"requirements": "SHALL know the subject context.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List (no V2 mapping for Group or Device)"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "DiagnosticReport.performer",
"short": "Responsible Diagnostic Service",
"definition": "The diagnostic service that is responsible for issuing the report.",
"comments": "This is not necessarily the source of the atomic data items - it is the entity that takes responsibility for the clinical report.",
"requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.",
"alias": [
"Laboratory",
"Service",
"Practitioner",
"Department",
"Company"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT-8-Participation Organization (where this PRT-4-Participation = \"PO\")"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].role[classCode=ASSIGN].scoper"
}
]
},
{
"path": "DiagnosticReport.encounter",
"short": "Health care event when test ordered",
"definition": "The link to the health care event (encounter) when the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.identifier",
"short": "Id for external references to this report",
"definition": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
"requirements": "Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context.",
"alias": [
"ReportID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-51-Observation Group ID (todo: check semantic intent of OBR-51 with OOWG)"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "DiagnosticReport.requestDetail",
"short": "What was requested",
"definition": "Details concerning a test requested.",
"comments": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.",
"requirements": "Need to be able to track completion of requests based on reports issued and also to report what diagnostic tests were requested (not always the same as what is delivered).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"path": "DiagnosticReport.serviceCategory",
"short": "Biochemistry, Hematology etc.",
"definition": "The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI.",
"requirements": "Help clinicians filter/find the reports they are looking for.",
"alias": [
"Department",
"Sub-department",
"service",
"discipline"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticServiceSection",
"strength": "example",
"description": "Codes for diagnostic service sections",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-service-sections"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-24-Diagnostic Service Section ID"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code"
}
]
},
{
"path": "DiagnosticReport.diagnostic[x]",
"short": "Physiologically Relevant time/time-period for report",
"definition": "The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.",
"comments": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.",
"requirements": "Need to know where in the patient history to file/present this report.",
"alias": [
"Observation time",
"Effective Time"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-7-Observation Date/Time"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "DiagnosticReport.specimen",
"short": "Specimens this report is based on",
"definition": "Details about the specimens on which this diagnostic report is based.",
"comments": "If the specimen is sufficiently specified with a code in the Test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per Observation or group.",
"requirements": "Need to be able to report information about the collected specimens on which the report is based.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "DiagnosticReport.result",
"short": "Observations - simple, or complex nested groups",
"definition": "Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. \"atomic\" results), or they can be grouping observations that include references to other members of the group (e.g. \"panels\").",
"requirements": "Need to be able to individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations.",
"alias": [
"Data",
"Atomic Value",
"Result",
"Atomic result",
"Data",
"Test",
"Analyte",
"Battery",
"Organiser"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DiagnosticReport.imagingStudy",
"short": "Reference to full details of imaging associated with the diagnostic report",
"definition": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.",
"comments": "ImagingStudy and image are somewhat overlapping - typically, an image in the image list will also be found in the imaging study resource. However the imaging study and image lists cater to different types of displays for different types of purposes. Neither, either, or both may be provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.image",
"short": "Key images associated with this report",
"definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).",
"requirements": "Many diagnostic services include images in the report as part of their service.",
"alias": [
"DICOM",
"Slides",
"Scans"
],
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX?"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DiagnosticReport.image.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticReport.image.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DiagnosticReport.image.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DiagnosticReport.image.comment",
"short": "Comment about the image (e.g. explanation)",
"definition": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.",
"comments": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.",
"requirements": "The provider of the report should make a comment about each image included in the report.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "DiagnosticReport.image.link",
"short": "Reference to the image source",
"definition": "Reference to the image source.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Media"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".value.reference"
}
]
},
{
"path": "DiagnosticReport.conclusion",
"short": "Clinical Interpretation of test results",
"definition": "Concise and clinically contextualized narrative interpretation of the diagnostic report.",
"comments": "Typically, a report is either [all data, no narrative (e.g. Core lab)] or [a mix of data with some concluding narrative (e.g. Structured Pathology Report, Bone Density)], or [all narrative (e.g. typical imaging report, histopathology)]. In all of these cases, the narrative goes in \"text\".",
"requirements": "Need to be able to provide a conclusion that is not lost amongst the basic result data.",
"alias": [
"Report"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)"
}
]
},
{
"path": "DiagnosticReport.codedDiagnosis",
"short": "Codes for the conclusion",
"definition": "Codes for the conclusion.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AdjunctDiagnosis",
"strength": "example",
"description": "Diagnoses codes provided as adjuncts to the report",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)"
}
]
},
{
"path": "DiagnosticReport.presentedForm",
"short": "Entire Report as issued",
"definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
"comments": "Application/pdf is recommended as the most reliable and interoperable in this context.",
"requirements": "Gives Laboratory the ability to provide its own fully formatted report for clinical fidelity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "text (type=ED)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DiagnosticReport",
"short": "A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports",
"definition": "The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports.",
"comments": "This is intended to capture a single report, and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing.",
"requirements": "To support reporting for any diagnostic report into a clinical data repository.",
"alias": [
"Report",
"Test",
"Result",
"Results",
"Labs",
"Laboratory"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.name",
"short": "Name/Code for this diagnostic report",
"definition": "A code or name that describes this diagnostic report.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticReportNames",
"strength": "required",
"description": "Codes that describe Diagnostic Reports",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/report-names"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4-Universal Service ID (V2 doesn't provide an easy way to indicate both the ordered test and the performed panel)"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "DiagnosticReport.status",
"short": "registered | partial | final | corrected | appended | cancelled | entered-in-error",
"definition": "The status of the diagnostic report as a whole.",
"comments": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
"requirements": "Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "DiagnosticReportStatus",
"strength": "required",
"description": "The status of the diagnostic report as a whole",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-report-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-25-Result Status (not 1:1 mapping)"
},
{
"identity": "rim",
"map": "statusCode\n\nNote: final and amended are distinguished by whether observation is the subject of a ControlAct event of type \"revise\""
}
]
},
{
"path": "DiagnosticReport.issued",
"short": "Date this version was released",
"definition": "The date and/or time that this version of the report was released from the source diagnostic service.",
"comments": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report .",
"requirements": "Clinicians need to be able to check the date that the report was released.",
"alias": [
"Date Created",
"Date published",
"Date Issued"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-22-Results Rpt/Status Chng - Date/Time"
},
{
"identity": "rim",
"map": "participation[typeCode=VRF or AUT].time"
}
]
},
{
"path": "DiagnosticReport.subject",
"short": "The subject of the report, usually, but not always, the patient",
"definition": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.",
"requirements": "SHALL know the subject context.",
"alias": [
"Patient"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List (no V2 mapping for Group or Device)"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "DiagnosticReport.performer",
"short": "Responsible Diagnostic Service",
"definition": "The diagnostic service that is responsible for issuing the report.",
"comments": "This is not necessarily the source of the atomic data items - it is the entity that takes responsibility for the clinical report.",
"requirements": "Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis.",
"alias": [
"Laboratory",
"Service",
"Practitioner",
"Department",
"Company"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT-8-Participation Organization (where this PRT-4-Participation = \"PO\")"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].role[classCode=ASSIGN].scoper"
}
]
},
{
"path": "DiagnosticReport.encounter",
"short": "Health care event when test ordered",
"definition": "The link to the health care event (encounter) when the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.identifier",
"short": "Id for external references to this report",
"definition": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
"requirements": "Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context.",
"alias": [
"ReportID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-51-Observation Group ID (todo: check semantic intent of OBR-51 with OOWG)"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "DiagnosticReport.requestDetail",
"short": "What was requested",
"definition": "Details concerning a test requested.",
"comments": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports.",
"requirements": "Need to be able to track completion of requests based on reports issued and also to report what diagnostic tests were requested (not always the same as what is delivered).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=FLFS].target"
}
]
},
{
"path": "DiagnosticReport.serviceCategory",
"short": "Biochemistry, Hematology etc.",
"definition": "The section of the diagnostic service that performs the examination e.g. biochemistry, hematology, MRI.",
"requirements": "Help clinicians filter/find the reports they are looking for.",
"alias": [
"Department",
"Sub-department",
"service",
"discipline"
],
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DiagnosticServiceSection",
"strength": "example",
"description": "Codes for diagnostic service sections",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-service-sections"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-24-Diagnostic Service Section ID"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code"
}
]
},
{
"path": "DiagnosticReport.diagnostic[x]",
"short": "Physiologically Relevant time/time-period for report",
"definition": "The time or time-period the observed values are related to. This is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.",
"comments": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.",
"requirements": "Need to know where in the patient history to file/present this report.",
"alias": [
"Observation time",
"Effective Time"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR-7-Observation Date/Time"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "DiagnosticReport.specimen",
"short": "Specimens this report is based on",
"definition": "Details about the specimens on which this diagnostic report is based.",
"comments": "If the specimen is sufficiently specified with a code in the Test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per Observation or group.",
"requirements": "Need to be able to report information about the collected specimens on which the report is based.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "DiagnosticReport.result",
"short": "Observations - simple, or complex nested groups",
"definition": "Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. \"atomic\" results), or they can be grouping observations that include references to other members of the group (e.g. \"panels\").",
"requirements": "Need to be able to individual results, or report groups of results, where the result grouping is arbitrary, but meaningful. This structure is recursive - observations can contain observations.",
"alias": [
"Data",
"Atomic Value",
"Result",
"Atomic result",
"Data",
"Test",
"Analyte",
"Battery",
"Organiser"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DiagnosticReport.imagingStudy",
"short": "Reference to full details of imaging associated with the diagnostic report",
"definition": "One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.",
"comments": "ImagingStudy and image are somewhat overlapping - typically, an image in the image list will also be found in the imaging study resource. However the imaging study and image lists cater to different types of displays for different types of purposes. Neither, either, or both may be provided.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target[classsCode=DGIMG, moodCode=EVN]"
}
]
},
{
"path": "DiagnosticReport.image",
"short": "Key images associated with this report",
"definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).",
"requirements": "Many diagnostic services include images in the report as part of their service.",
"alias": [
"DICOM",
"Slides",
"Scans"
],
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX?"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DiagnosticReport.image.comment",
"short": "Comment about the image (e.g. explanation)",
"definition": "A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features.",
"comments": "The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion.",
"requirements": "The provider of the report should make a comment about each image included in the report.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "DiagnosticReport.image.link",
"short": "Reference to the image source",
"definition": "Reference to the image source.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Media"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".value.reference"
}
]
},
{
"path": "DiagnosticReport.conclusion",
"short": "Clinical Interpretation of test results",
"definition": "Concise and clinically contextualized narrative interpretation of the diagnostic report.",
"comments": "Typically, a report is either [all data, no narrative (e.g. Core lab)] or [a mix of data with some concluding narrative (e.g. Structured Pathology Report, Bone Density)], or [all narrative (e.g. typical imaging report, histopathology)]. In all of these cases, the narrative goes in \"text\".",
"requirements": "Need to be able to provide a conclusion that is not lost amongst the basic result data.",
"alias": [
"Report"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=\"SPRT\"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)"
}
]
},
{
"path": "DiagnosticReport.codedDiagnosis",
"short": "Codes for the conclusion",
"definition": "Codes for the conclusion.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AdjunctDiagnosis",
"strength": "example",
"description": "Diagnoses codes provided as adjuncts to the report",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)"
}
]
},
{
"path": "DiagnosticReport.presentedForm",
"short": "Entire Report as issued",
"definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
"comments": "Application/pdf is recommended as the most reliable and interoperable in this context.",
"requirements": "Gives Laboratory the ability to provide its own fully formatted report for clinical fidelity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "text (type=ED)"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DocumentManifest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DocumentManifest",
"name": "DocumentManifest",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DocumentManifest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "xds",
"uri": "http://ihe.net/xds",
"name": "XDS"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DocumentManifest",
"short": "A manifest that defines a set of documents",
"definition": "A manifest that defines a set of documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "DocumentManifest"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
}
]
},
{
"path": "DocumentManifest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DocumentManifest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DocumentManifest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DocumentManifest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DocumentManifest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DocumentManifest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentManifest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentManifest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentManifest.masterIdentifier",
"short": "Unique Identifier for the set of documents",
"definition": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.uniqueId"
},
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
}
]
},
{
"path": "DocumentManifest.identifier",
"short": "Other identifiers for the manifest",
"definition": "Other identifiers associated with the document manifest, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.entryUUID"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
}
]
},
{
"path": "DocumentManifest.subject",
"short": "The subject of the set of documents",
"definition": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.patientId"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "DocumentManifest.recipient",
"short": "Intended to get notified about this set of documents",
"definition": "A patient, practitioner, or organization for which this set of documents is intended.",
"comments": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.intendedRecipient"
},
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
}
]
},
{
"path": "DocumentManifest.type",
"short": "What kind of document set this is",
"definition": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Type",
"strength": "preferred",
"description": "Precice type of clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.contentTypeCode"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DocumentManifest.author",
"short": "Who and/or what authored the document",
"definition": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "DocumentManifest.created",
"short": "When this document manifest created",
"definition": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc).",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.submissionTime"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "DocumentManifest.source",
"short": "The source system/application/software",
"definition": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.sourceId"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
}
]
},
{
"path": "DocumentManifest.status",
"short": "current | superceded | entered-in-error",
"definition": "The status of this document manifest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"strength": "required",
"description": "The status of the document reference",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "DocumentManifest.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.title"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "DocumentManifest.content",
"short": "Contents of this set of documents",
"definition": "The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Binary"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Media"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet DocumentEntry(s)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DocumentManifest.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentManifest.",
"comments": "May be identifiers or resources that caused the DocumentManifest to be created.",
"min": 0,
"max": "*"
},
{
"path": "DocumentManifest.related.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentManifest.related.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentManifest.related.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentManifest.related.identifier",
"short": "Related Identifier",
"definition": "Related identifier to this DocumentManifest. If both id and ref are present they shall refer to the same thing.",
"comments": "Order numbers, accession numbers, XDW workflow numbers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DocumentManifest.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentManifest. If both id and ref are present they shall refer to the same thing.",
"comments": "Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DocumentManifest",
"short": "A manifest that defines a set of documents",
"definition": "A manifest that defines a set of documents.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=FOLDER, moodCode=EVN]"
}
]
},
{
"path": "DocumentManifest.masterIdentifier",
"short": "Unique Identifier for the set of documents",
"definition": "A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.uniqueId"
},
{
"identity": "rim",
"map": "id [need a list semantic to indicate order matters]"
}
]
},
{
"path": "DocumentManifest.identifier",
"short": "Other identifiers for the manifest",
"definition": "Other identifiers associated with the document manifest, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.entryUUID"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
}
]
},
{
"path": "DocumentManifest.subject",
"short": "The subject of the set of documents",
"definition": "Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.patientId"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "DocumentManifest.recipient",
"short": "Intended to get notified about this set of documents",
"definition": "A patient, practitioner, or organization for which this set of documents is intended.",
"comments": "How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.intendedRecipient"
},
{
"identity": "rim",
"map": ".participation[typeCode=IRCP].role"
}
]
},
{
"path": "DocumentManifest.type",
"short": "What kind of document set this is",
"definition": "Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Type",
"strength": "preferred",
"description": "Precice type of clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.contentTypeCode"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DocumentManifest.author",
"short": "Who and/or what authored the document",
"definition": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.author"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "DocumentManifest.created",
"short": "When this document manifest created",
"definition": "When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated etc).",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.submissionTime"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "DocumentManifest.source",
"short": "The source system/application/software",
"definition": "Identifies the source system, application, or software that produced the document manifest.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.sourceId"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].time"
}
]
},
{
"path": "DocumentManifest.status",
"short": "current | superceded | entered-in-error",
"definition": "The status of this document manifest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"strength": "required",
"description": "The status of the document reference",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "DocumentManifest.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet.title"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "DocumentManifest.content",
"short": "Contents of this set of documents",
"definition": "The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowed.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Binary"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Media"
}
],
"mapping": [
{
"identity": "xds",
"map": "SubmissionSet DocumentEntry(s)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"path": "DocumentManifest.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentManifest.",
"comments": "May be identifiers or resources that caused the DocumentManifest to be created.",
"min": 0,
"max": "*"
},
{
"path": "DocumentManifest.related.identifier",
"short": "Related Identifier",
"definition": "Related identifier to this DocumentManifest. If both id and ref are present they shall refer to the same thing.",
"comments": "Order numbers, accession numbers, XDW workflow numbers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "DocumentManifest.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentManifest. If both id and ref are present they shall refer to the same thing.",
"comments": "Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "DocumentReference",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DocumentReference",
"name": "DocumentReference",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for DocumentReference Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "xds",
"uri": "http://ihe.net/xds",
"name": "XDS"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "DocumentReference",
"short": "A reference to a document",
"definition": "A reference to a document.",
"comments": "Usually, this is used for documents other than those defined by FHIR.",
"min": 1,
"max": "1",
"type": [
{
"code": "DocumentReference"
}
],
"mapping": [
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "DocumentReference.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "DocumentReference.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "DocumentReference.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "DocumentReference.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DocumentReference.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DocumentReference.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.masterIdentifier",
"short": "Master Version Specific Identifier",
"definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.",
"comments": "CDA Document Id extension and root.",
"requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.uniqueId"
},
{
"identity": "v2",
"map": "TXA-12-Unique Document Number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "DocumentReference.identifier",
"short": "Other identifiers for the document",
"definition": "Other identifiers associated with the document, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.entryUUID"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
}
]
},
{
"path": "DocumentReference.subject",
"short": "Who|what is the subject of the document",
"definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.patientId"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
}
]
},
{
"path": "DocumentReference.type",
"short": "Precise type of document",
"definition": "The type code specifies the precise type of document from the user perspective. It is recommended that the value Set be drawn from a coding scheme providing a fine level of granularity such as LOINC. (e.g. Patient Summary, Discharge Summary, Prescription, etc.).",
"comments": "Key metadata element describing the document, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Type",
"strength": "preferred",
"description": "Precice type of clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.type"
},
{
"identity": "v2",
"map": "TXA-2-Document Type"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "DocumentReference.class",
"short": "High-level classification of document",
"definition": "The class code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).",
"comments": "Helps humans to assess whether the document is of interest when viewing an list of documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Class",
"strength": "preferred",
"description": "High-level classification of a clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-classcodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.class"
},
{
"identity": "v2",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "DocumentReference.format",
"short": "Format/content rules for the document",
"definition": "An identifier that identifies the the document encoding, structure and template that the document conforms to beyond the base format indicated in the mimeType.",
"comments": "Helps the processing. Usually is a URN that identifies. For IHE defined Document Content profiles this is a urn issued by IHE.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"binding": {
"name": "DocumentIHEFormat",
"strength": "preferred",
"description": "Document Format Codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ihe-formatcodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.formatCode"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.author",
"short": "Who and/or what authored the document",
"definition": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.author"
},
{
"identity": "v2",
"map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "DocumentReference.custodian",
"short": "Org which maintains the document",
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"comments": "Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
},
{
"path": "DocumentReference.authenticator",
"short": "Who/What authenticated the document",
"definition": "Which person or organization authenticates that this document is valid.",
"comments": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.legalAuthenticator"
},
{
"identity": "v2",
"map": "TXA-10-Assigned Document Authenticator"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "DocumentReference.created",
"short": "Document creation time",
"definition": "When the document was created.",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.submissionTime"
},
{
"identity": "v2",
"map": "TXA-6-Origination Date/Time"
},
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
}
]
},
{
"path": "DocumentReference.indexed",
"short": "When this document reference created",
"definition": "When the document reference was created.",
"comments": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.submissionTime"
},
{
"identity": "rim",
"map": ".availabilityTime[type=\"TS\"]"
}
]
},
{
"path": "DocumentReference.status",
"short": "current | superceded | entered-in-error",
"definition": "The status of this document reference.",
"comments": "This is the status of the DocumentReference object, which might be independent from the docStatus.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"strength": "required",
"description": "The status of the document reference",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry status"
},
{
"identity": "v2",
"map": "TXA-19-Document Availability Status"
},
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
}
]
},
{
"path": "DocumentReference.docStatus",
"short": "preliminary | final | appended | amended | entered-in-error",
"definition": "The status of the underlying document.",
"comments": "The document that is pointed to might be in various lifecycle states.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ReferredDocumentStatus",
"strength": "required",
"description": "Status of the underlying document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "TXA-17-Document Completion Status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "DocumentReference.relatesTo",
"short": "Relationships to other documents",
"definition": "Relationships that this document has with other document references that already exist.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship"
}
]
},
{
"path": "DocumentReference.relatesTo.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.relatesTo.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.relatesTo.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.relatesTo.code",
"short": "replaces | transforms | signs | appends",
"definition": "The type of relationship that this document has with anther document.",
"comments": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DocumentRelationshipType",
"strength": "required",
"description": "The type of relationship between documents",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-relationship-type"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry Associations type"
},
{
"identity": "rim",
"map": ".outboundRelationship.typeCode"
}
]
},
{
"path": "DocumentReference.relatesTo.target",
"short": "Target of the relationship",
"definition": "The target document of this relationship.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry Associations reference"
},
{
"identity": "rim",
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
}
]
},
{
"path": "DocumentReference.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.description"
},
{
"identity": "v2",
"map": "TXA-25-Document Title"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text"
}
]
},
{
"path": "DocumentReference.confidentiality",
"short": "Document security-tags",
"definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document.",
"comments": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n• [1…1] Confidentiality Security Classification Label Field\n• [0…*] Sensitivity Security Category Label Field\n• [0…*] Compartment Security Category Label Field\n• [0…*] Integrity Security Category Label Field\n• [0…*] Handling Caveat Security Category Field\nIn the HL7 Healthcare Privacy and Security Classification System In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.",
"requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "HCS",
"strength": "extensible",
"description": "Healthcare Privacy and Security Classification System",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/security-labels"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.confidentialityCode"
},
{
"identity": "v2",
"map": "TXA-18-Document Confidentiality Status"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "DocumentReference.content",
"short": "Where to access the document",
"definition": "The document or url to the document along with critical metadata to prove content has integrity.",
"min": 1,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.mimeType\nDocumentEntry.languageCode\nDocumentEntry.URI\nDocumentEntry.size\nDocumentEntry.hash\nDocumentEntry.title"
}
]
},
{
"path": "DocumentReference.context",
"short": "Clinical context of document",
"definition": "The clinical context in which the document was prepared.",
"comments": "These values are primarily added to help with searching for interesting/relevant documents.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
},
{
"path": "DocumentReference.context.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.context.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.context.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.context.event",
"short": "Main Clinical Acts Documented",
"definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the type, such as \nwhere it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.eventCodeList"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DocumentReference.context.period",
"short": "Time of service that is being documented",
"definition": "The time period over which the service that is described by the document was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.serviceStartTime\nDocumentEntry.serviceStopTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "DocumentReference.context.facilityType",
"short": "Kind of facility where patient was seen",
"definition": "The kind of facility where the patient was seen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80FacilityType",
"strength": "preferred",
"description": "XDS Facility Type",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-facilitycodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.healthcareFacilityTypeCode"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
}
]
},
{
"path": "DocumentReference.context.practiceSetting",
"short": "Additional details about where the content was created (e.g. clinical specialty)",
"definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.",
"comments": "The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration:\n* HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED-CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011\n* ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3]\n* XDS Connect-a-thon practiceSettingCode.",
"requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.practiceSettingCode"
}
]
},
{
"path": "DocumentReference.context.sourcePatientInfo",
"short": "Source patient info",
"definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.sourcePatientInfo\nDocumentEntry.sourcePatientId"
}
]
},
{
"path": "DocumentReference.context.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentReference.",
"comments": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.",
"min": 0,
"max": "*"
},
{
"path": "DocumentReference.context.related.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.context.related.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.context.related.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DocumentReference.context.related.identifier",
"short": "Related Identifier",
"definition": "Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"comments": "Order numbers, accession numbers, XDW workflow numbers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.referenceIdList"
}
]
},
{
"path": "DocumentReference.context.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"comments": "Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DocumentReference",
"short": "A reference to a document",
"definition": "A reference to a document.",
"comments": "Usually, this is used for documents other than those defined by FHIR.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Document[classCode=\"DOC\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "DocumentReference.masterIdentifier",
"short": "Master Version Specific Identifier",
"definition": "Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.",
"comments": "CDA Document Id extension and root.",
"requirements": "The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.).",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.uniqueId"
},
{
"identity": "v2",
"map": "TXA-12-Unique Document Number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "DocumentReference.identifier",
"short": "Other identifiers for the document",
"definition": "Other identifiers associated with the document, including version independent identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.entryUUID"
},
{
"identity": "v2",
"map": "TXA-16-Unique Document File Name?"
},
{
"identity": "rim",
"map": ".id / .setId"
}
]
},
{
"path": "DocumentReference.subject",
"short": "Who|what is the subject of the document",
"definition": "Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.patientId"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SBJ\"].role[typeCode=\"PAT\"]"
}
]
},
{
"path": "DocumentReference.type",
"short": "Precise type of document",
"definition": "The type code specifies the precise type of document from the user perspective. It is recommended that the value Set be drawn from a coding scheme providing a fine level of granularity such as LOINC. (e.g. Patient Summary, Discharge Summary, Prescription, etc.).",
"comments": "Key metadata element describing the document, used in searching/filtering.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Type",
"strength": "preferred",
"description": "Precice type of clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-typecodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.type"
},
{
"identity": "v2",
"map": "TXA-2-Document Type"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "DocumentReference.class",
"short": "High-level classification of document",
"definition": "The class code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).",
"comments": "Helps humans to assess whether the document is of interest when viewing an list of documents.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80Class",
"strength": "preferred",
"description": "High-level classification of a clinical document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-doc-classcodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.class"
},
{
"identity": "v2",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "DocumentReference.format",
"short": "Format/content rules for the document",
"definition": "An identifier that identifies the the document encoding, structure and template that the document conforms to beyond the base format indicated in the mimeType.",
"comments": "Helps the processing. Usually is a URN that identifies. For IHE defined Document Content profiles this is a urn issued by IHE.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"binding": {
"name": "DocumentIHEFormat",
"strength": "preferred",
"description": "Document Format Codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ihe-formatcodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.formatCode"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DocumentReference.author",
"short": "Who and/or what authored the document",
"definition": "Identifies who is responsible for adding the information to the document.",
"comments": "Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant).",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.author"
},
{
"identity": "v2",
"map": "TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUT\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "DocumentReference.custodian",
"short": "Org which maintains the document",
"definition": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.",
"comments": "Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location of the document, which host may be delegated to the management of some other organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=\"RCV\"].role[classCode=\"CUST\"].scoper[classCode=\"ORG\" and determinerCode=\"INST\"]"
}
]
},
{
"path": "DocumentReference.authenticator",
"short": "Who/What authenticated the document",
"definition": "Which person or organization authenticates that this document is valid.",
"comments": "Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.legalAuthenticator"
},
{
"identity": "v2",
"map": "TXA-10-Assigned Document Authenticator"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"AUTHEN\"].role[classCode=\"ASSIGNED\"]"
}
]
},
{
"path": "DocumentReference.created",
"short": "Document creation time",
"definition": "When the document was created.",
"comments": "Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.submissionTime"
},
{
"identity": "v2",
"map": "TXA-6-Origination Date/Time"
},
{
"identity": "rim",
"map": ".effectiveTime[type=\"TS\"]"
}
]
},
{
"path": "DocumentReference.indexed",
"short": "When this document reference created",
"definition": "When the document reference was created.",
"comments": "Referencing/indexing time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.submissionTime"
},
{
"identity": "rim",
"map": ".availabilityTime[type=\"TS\"]"
}
]
},
{
"path": "DocumentReference.status",
"short": "current | superceded | entered-in-error",
"definition": "The status of this document reference.",
"comments": "This is the status of the DocumentReference object, which might be independent from the docStatus.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "DocumentReferenceStatus",
"strength": "required",
"description": "The status of the document reference",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-reference-status"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry status"
},
{
"identity": "v2",
"map": "TXA-19-Document Availability Status"
},
{
"identity": "rim",
"map": "interim: .completionCode=\"IN\" & ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct()]);\n\namended: .completionCode=\"AU\" && ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseDocument\", code) and isNormalAct() and statusCode=\"completed\"];\n\nwithdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]=\"obsolete\""
}
]
},
{
"path": "DocumentReference.docStatus",
"short": "preliminary | final | appended | amended | entered-in-error",
"definition": "The status of the underlying document.",
"comments": "The document that is pointed to might be in various lifecycle states.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ReferredDocumentStatus",
"strength": "required",
"description": "Status of the underlying document",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/composition-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "TXA-17-Document Completion Status"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "DocumentReference.relatesTo",
"short": "Relationships to other documents",
"definition": "Relationships that this document has with other document references that already exist.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship"
}
]
},
{
"path": "DocumentReference.relatesTo.code",
"short": "replaces | transforms | signs | appends",
"definition": "The type of relationship that this document has with anther document.",
"comments": "If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "DocumentRelationshipType",
"strength": "required",
"description": "The type of relationship between documents",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/document-relationship-type"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry Associations type"
},
{
"identity": "rim",
"map": ".outboundRelationship.typeCode"
}
]
},
{
"path": "DocumentReference.relatesTo.target",
"short": "Target of the relationship",
"definition": "The target document of this relationship.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DocumentReference"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry Associations reference"
},
{
"identity": "rim",
"map": ".target[classCode=\"DOC\", moodCode=\"EVN\"].id"
}
]
},
{
"path": "DocumentReference.description",
"short": "Human-readable description (title)",
"definition": "Human-readable description of the source document. This is sometimes known as the \"title\".",
"comments": "What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a \"consultation\" or \"progress note\").",
"requirements": "Helps humans to assess whether the document is of interest.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.description"
},
{
"identity": "v2",
"map": "TXA-25-Document Title"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"SUBJ\"].target.text"
}
]
},
{
"path": "DocumentReference.confidentiality",
"short": "Document security-tags",
"definition": "A set of Security-Tag codes specifying the level of privacy/security of the Document.",
"comments": "The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. \n• [1…1] Confidentiality Security Classification Label Field\n• [0…*] Sensitivity Security Category Label Field\n• [0…*] Compartment Security Category Label Field\n• [0…*] Integrity Security Category Label Field\n• [0…*] Handling Caveat Security Category Field\nIn the HL7 Healthcare Privacy and Security Classification System In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects.",
"requirements": "Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "HCS",
"strength": "extensible",
"description": "Healthcare Privacy and Security Classification System",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/security-labels"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.confidentialityCode"
},
{
"identity": "v2",
"map": "TXA-18-Document Confidentiality Status"
},
{
"identity": "rim",
"map": ".confidentialityCode"
}
]
},
{
"path": "DocumentReference.content",
"short": "Where to access the document",
"definition": "The document or url to the document along with critical metadata to prove content has integrity.",
"min": 1,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.mimeType\nDocumentEntry.languageCode\nDocumentEntry.URI\nDocumentEntry.size\nDocumentEntry.hash\nDocumentEntry.title"
}
]
},
{
"path": "DocumentReference.context",
"short": "Clinical context of document",
"definition": "The clinical context in which the document was prepared.",
"comments": "These values are primarily added to help with searching for interesting/relevant documents.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=\"SUBJ\"].target[classCode<'ACT']"
}
]
},
{
"path": "DocumentReference.context.event",
"short": "Main Clinical Acts Documented",
"definition": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act.",
"comments": "An event can further specialize the act inherent in the type, such as \nwhere it is simply \"Procedure Report\" and the procedure was a \"colonoscopy\". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.eventCodeList"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "DocumentReference.context.period",
"short": "Time of service that is being documented",
"definition": "The time period over which the service that is described by the document was provided.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.serviceStartTime\nDocumentEntry.serviceStopTime"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "DocumentReference.context.facilityType",
"short": "Kind of facility where patient was seen",
"definition": "The kind of facility where the patient was seen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80FacilityType",
"strength": "preferred",
"description": "XDS Facility Type",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-facilitycodes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.healthcareFacilityTypeCode"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"LOC\"].role[classCode=\"DSDLOC\"].code"
}
]
},
{
"path": "DocumentReference.context.practiceSetting",
"short": "Additional details about where the content was created (e.g. clinical specialty)",
"definition": "This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.",
"comments": "The value set for this content has an example binding because it is a value set decided by community policy. Other examples exist for consideration:\n* HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED-CT which is referenced by Direct (XDR and XDM for Direct Messaging Specification, Version 1), as well as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011\n* ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3]\n* XDS Connect-a-thon practiceSettingCode.",
"requirements": "This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.practiceSettingCode"
}
]
},
{
"path": "DocumentReference.context.sourcePatientInfo",
"short": "Source patient info",
"definition": "The Patient Information as known when the document was published. May be a reference to a version specific, or contained.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.sourcePatientInfo\nDocumentEntry.sourcePatientId"
}
]
},
{
"path": "DocumentReference.context.related",
"short": "Related things",
"definition": "Related identifiers or resources associated with the DocumentReference.",
"comments": "May be identifiers or resources that caused the DocumentReference or referenced Document to be created.",
"min": 0,
"max": "*"
},
{
"path": "DocumentReference.context.related.identifier",
"short": "Related Identifier",
"definition": "Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"comments": "Order numbers, accession numbers, XDW workflow numbers.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "xds",
"map": "DocumentEntry.referenceIdList"
}
]
},
{
"path": "DocumentReference.context.related.ref",
"short": "Related Resource",
"definition": "Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.",
"comments": "Order, DiagnosticOrder, Procedure, EligibilityRequest, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "EligibilityRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest",
"name": "EligibilityRequest",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for EligibilityRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "EligibilityRequest",
"short": "Eligibility request",
"definition": "This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service.",
"min": 1,
"max": "1",
"type": [
{
"code": "EligibilityRequest"
}
]
},
{
"path": "EligibilityRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "EligibilityRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "EligibilityRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "EligibilityRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "EligibilityRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "EligibilityRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityRequest.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EligibilityRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EligibilityRequest.target",
"short": "Insurer",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EligibilityRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EligibilityRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
},
"differential": {
"element": [
{
"path": "EligibilityRequest",
"short": "Eligibility request",
"definition": "This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "EligibilityRequest.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EligibilityRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EligibilityRequest.target",
"short": "Insurer",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EligibilityRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EligibilityRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "EligibilityResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/EligibilityResponse",
"name": "EligibilityResponse",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for EligibilityResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "EligibilityResponse",
"short": "EligibilityResponse resource",
"definition": "This resource provides eligibility and plan details from the processing of an Eligibility resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "EligibilityResponse"
}
]
},
{
"path": "EligibilityResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "EligibilityResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "EligibilityResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "EligibilityResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "EligibilityResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "EligibilityResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EligibilityResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EligibilityResponse.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "EligibilityResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "EligibilityResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "EligibilityResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EligibilityResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EligibilityResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EligibilityResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
},
"differential": {
"element": [
{
"path": "EligibilityResponse",
"short": "EligibilityResponse resource",
"definition": "This resource provides eligibility and plan details from the processing of an Eligibility resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "EligibilityResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EligibilityResponse.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EligibilityRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "EligibilityResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "EligibilityResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "EligibilityResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EligibilityResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EligibilityResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EligibilityResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EligibilityResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Encounter-everything",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Encounter-everything",
"name": "Fetch Encounter Record",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for rhis operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).\r\rThe server SHOULD return all resources that it has that are in the encounter compartment for the identified encounter, and any resource referenced from those, including binaries and attachments. In the US Realm, At a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (ref to be provided). Other applicable implementation guides may make additional rules about the information that is returned. \n\nNote that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "everything",
"notes": "The key differences between this operation and simply searching the encounter compartment are:\r\r\n* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)\r\n* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)",
"system": false,
"instance": true,
"parameter": [
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The bundle type is \"searchset\"",
"type": "Bundle"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Encounter",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Encounter",
"name": "Encounter",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Encounter Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Encounter",
"short": "An interaction during which services are provided to the patient",
"definition": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
"alias": [
"Visit"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Encounter"
}
],
"mapping": [
{
"identity": "rim",
"map": "Encounter[moodCode=EVN]"
}
]
},
{
"path": "Encounter.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Encounter.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Encounter.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Encounter.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Encounter.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Encounter.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.identifier",
"short": "Identifier(s) by which this encounter is known",
"definition": "Identifier(s) by which this encounter is known.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PV1-19-visit number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Encounter.status",
"short": "planned | arrived | in-progress | onleave | finished | cancelled",
"definition": "planned | arrived | in-progress | onleave | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "EncounterState",
"strength": "required",
"description": "Current state of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-state"
}
},
"mapping": [
{
"identity": "v2",
"map": "No clear equivalent in V2.x; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Encounter.statusHistory",
"short": "List of Encounter statuses",
"definition": "The current status is always found in the current version of the resource. This status history permits the encounter resource to contain the status history without the needing to read through the historical versions of the resource, or even have the server store them.",
"min": 0,
"max": "*"
},
{
"path": "Encounter.statusHistory.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.statusHistory.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.statusHistory.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.statusHistory.status",
"short": "planned | arrived | in-progress | onleave | finished | cancelled",
"definition": "planned | arrived | in-progress | onleave | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EncounterState",
"strength": "required",
"description": "Current state of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-state"
}
}
},
{
"path": "Encounter.statusHistory.period",
"short": "The time that the episode was in the specified status",
"definition": "The time that the episode was in the specified status.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "Encounter.class",
"short": "inpatient | outpatient | ambulatory | emergency +",
"definition": "inpatient | outpatient | ambulatory | emergency +.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "EncounterClass",
"strength": "required",
"description": "Classification of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-class"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-2-patient class"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code"
}
]
},
{
"path": "Encounter.type",
"short": "Specific type of encounter",
"definition": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
"comments": "Since there are many ways to further classify encounters, this element is 0..*.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EncounterType",
"strength": "example",
"description": "The type of encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-4-admission type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Encounter.patient",
"short": "The patient present at the encounter",
"definition": "The patient present at the encounter.",
"comments": "While the encounter is always about the patient, the patient may not actually be known in all contexts of use.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ]/role[classCode=PAT]"
}
]
},
{
"path": "Encounter.episodeOfCare",
"short": "An episode of care that this encounter should be recorded against",
"definition": "Where a specific encounter should be classified as a part of a specific episode of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as govt reporting, or issue tracking.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PV1-54, PV1-53"
}
]
},
{
"path": "Encounter.incomingReferralRequest",
"short": "Incoming Referral Request",
"definition": "The referral request that this encounter is satisfies (incoming referral).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "Encounter.participant",
"short": "List of participants involved in the encounter",
"definition": "The main practitioner responsible for providing the service.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ROL"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "Encounter.participant.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.participant.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.participant.type",
"short": "Role of participant in encounter",
"definition": "Role of participant in encounter.",
"comments": "The Participant Type indicates how an individual parcitipates in an encounter. It includes non practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the Practitioner Roles which are functional roles, derived from terms of employment, education, licensing, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ROL-3"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "Encounter.participant.period",
"short": "Period of time during the encounter participant was present",
"definition": "The period of time that the specified participant was present during the encounter. These can overlap or be sub-sets of the overall encounters period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "ROL-5, ROL-6"
}
]
},
{
"path": "Encounter.participant.individual",
"short": "Persons involved in the encounter other than the patient",
"definition": "Persons involved in the encounter other than the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ROL-4"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Encounter.fulfills",
"short": "The appointment that scheduled this encounter",
"definition": "The appointment that scheduled this encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SCH-1-placer appointment ID / SCH-2-filler appointment ID"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]"
}
]
},
{
"path": "Encounter.period",
"short": "The start and end time of the encounter",
"definition": "The start and end time of the encounter.",
"comments": "If not (yet) known, the end of the Period may be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-44, PV1-45"
},
{
"identity": "rim",
"map": ".effectiveTime\n(low & high)"
}
]
},
{
"path": "Encounter.length",
"short": "Quantity of time the encounter lasted (less time absent)",
"definition": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.",
"comments": "May differ from the time the Encounter.period lasted because of leave of absence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "v2",
"map": "(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes"
},
{
"identity": "rim",
"map": ".lengthOfStayQuantity"
}
]
},
{
"path": "Encounter.reason",
"short": "Reason the encounter takes place (code)",
"definition": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EncounterReason",
"strength": "example",
"description": "Reason why the encounter takes place",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "EVN-4-event reason code / PV2-3-admit reason (note: PV2-3 is nominally constrained to inpatient admissions; V2.x makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations\n)"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "Encounter.indication",
"short": "Reason the encounter takes place (resource)",
"definition": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.\nThe indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"alias": [
"Admission diagnosis"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively."
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"path": "Encounter.priority",
"short": "Indicates the urgency of the encounter",
"definition": "Indicates the urgency of the encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Priority",
"strength": "example",
"description": "Indicates the urgency of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-priority"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV2-25-visit priority code"
},
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "Encounter.hospitalization",
"short": "Details about an admission to a clinic",
"definition": "Details about an admission to a clinic.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Encounter.hospitalization.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.hospitalization.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.hospitalization.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.hospitalization.preAdmissionIdentifier",
"short": "Pre-admission identifier",
"definition": "Pre-admission identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-5-preadmit number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Encounter.hospitalization.origin",
"short": "The location from which the patient came before admission",
"definition": "The location from which the patient came before admission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=ORG].role"
}
]
},
{
"path": "Encounter.hospitalization.admitSource",
"short": "From where patient was admitted (physician referral, transfer)",
"definition": "From where patient was admitted (physician referral, transfer).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AdmitSource",
"strength": "required",
"description": "From where the patient was admitted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-admit-source"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-14-admit source"
},
{
"identity": "rim",
"map": ".admissionReferralSourceCode"
}
]
},
{
"path": "Encounter.hospitalization.diet",
"short": "Dietary restrictions for the patient",
"definition": "Dietary restrictions for the patient.",
"requirements": "Track patients reported dietary restrictions to help with catering requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "PatientDiet",
"strength": "example",
"description": "Medical, cultural or ethical food preferences to help with catering requirements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-diet"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-38-diet type"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code=\"diet\"]"
}
]
},
{
"path": "Encounter.hospitalization.specialCourtesy",
"short": "Special courtesies (VIP, board member)",
"definition": "Special courtesies (VIP, board member).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Courtesies",
"strength": "required",
"description": "Special courtesies",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-special-courtesy"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-16-VIP indicator"
},
{
"identity": "rim",
"map": ".specialCourtesiesCode"
}
]
},
{
"path": "Encounter.hospitalization.specialArrangement",
"short": "Wheelchair, translator, stretcher, etc",
"definition": "Wheelchair, translator, stretcher, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Arrangements",
"strength": "required",
"description": "Special arrangements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-special-arrangements"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-15-ambulatory status / OBR-30-transportation mode / OBR-43-planned patient transport comment"
},
{
"identity": "rim",
"map": ".specialArrangementCode"
}
]
},
{
"path": "Encounter.hospitalization.destination",
"short": "Location to which the patient is discharged",
"definition": "Location to which the patient is discharged.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-37"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST]"
}
]
},
{
"path": "Encounter.hospitalization.dischargeDisposition",
"short": "Category or kind of location after discharge",
"definition": "Category or kind of location after discharge.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DischargeDisp",
"strength": "required",
"description": "Discharge Disposition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-discharge-disposition"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-36-discharge disposition"
},
{
"identity": "rim",
"map": ".dischargeDispositionCode"
}
]
},
{
"path": "Encounter.hospitalization.dischargeDiagnosis",
"short": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete",
"definition": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target[classCode=OBS, moodCode=EVN, code=ASSERTION].value"
}
]
},
{
"path": "Encounter.hospitalization.reAdmission",
"short": "Is this hospitalization a readmission?",
"definition": "Whether this hospitalization is a readmission.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-13-re-admission indicator"
},
{
"identity": "rim",
"map": "Propose at harmonization"
}
]
},
{
"path": "Encounter.location",
"short": "List of locations the patient has been at",
"definition": "List of locations at which the patient has been.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC]"
}
]
},
{
"path": "Encounter.location.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.location.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Encounter.location.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Encounter.location.location",
"short": "Location the encounter takes place",
"definition": "The location where the encounter takes place.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-3-assigned patient location / PV1-6-prior patient location / PV1-11-temporary location / PV1-42-pending location / PV1-43-prior temporary location"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Encounter.location.status",
"short": "planned | present | reserved",
"definition": "The status of the participants presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EncounterLocationStatus",
"strength": "required",
"description": "The status of the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-location-status"
}
}
},
{
"path": "Encounter.location.period",
"short": "Time period during which the patient was present at the location",
"definition": "Time period during which the patient was present at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".time"
}
]
},
{
"path": "Encounter.serviceProvider",
"short": "The custodian organization of this Encounter record",
"definition": "An organization that is in charge of maintaining the information of this Encounter (e.g., who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-10-hospital service / PL.6 Person Location Type & PL.1 Point of Care (note: V2.x definition is \"the treatment or type of surgery that the patient is scheduled to receive\"; seems slightly out of alignment with the concept name 'hospital service'. Would not trust that implementations apply this semantic by default)"
},
{
"identity": "rim",
"map": ".particiaption[typeCode=PFM].role"
}
]
},
{
"path": "Encounter.partOf",
"short": "Another Encounter this encounter is part of",
"definition": "Another Encounter of which this encounter is a part of (administratively or in time).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Encounter",
"short": "An interaction during which services are provided to the patient",
"definition": "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
"alias": [
"Visit"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Encounter[moodCode=EVN]"
}
]
},
{
"path": "Encounter.identifier",
"short": "Identifier(s) by which this encounter is known",
"definition": "Identifier(s) by which this encounter is known.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PV1-19-visit number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Encounter.status",
"short": "planned | arrived | in-progress | onleave | finished | cancelled",
"definition": "planned | arrived | in-progress | onleave | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "EncounterState",
"strength": "required",
"description": "Current state of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-state"
}
},
"mapping": [
{
"identity": "v2",
"map": "No clear equivalent in V2.x; active/finished could be inferred from PV1-44, PV1-45, PV2-24; inactive could be inferred from PV2-16"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "Encounter.statusHistory",
"short": "List of Encounter statuses",
"definition": "The current status is always found in the current version of the resource. This status history permits the encounter resource to contain the status history without the needing to read through the historical versions of the resource, or even have the server store them.",
"min": 0,
"max": "*"
},
{
"path": "Encounter.statusHistory.status",
"short": "planned | arrived | in-progress | onleave | finished | cancelled",
"definition": "planned | arrived | in-progress | onleave | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EncounterState",
"strength": "required",
"description": "Current state of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-state"
}
}
},
{
"path": "Encounter.statusHistory.period",
"short": "The time that the episode was in the specified status",
"definition": "The time that the episode was in the specified status.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "Encounter.class",
"short": "inpatient | outpatient | ambulatory | emergency +",
"definition": "inpatient | outpatient | ambulatory | emergency +.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "EncounterClass",
"strength": "required",
"description": "Classification of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-class"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-2-patient class"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code"
}
]
},
{
"path": "Encounter.type",
"short": "Specific type of encounter",
"definition": "Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).",
"comments": "Since there are many ways to further classify encounters, this element is 0..*.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EncounterType",
"strength": "example",
"description": "The type of encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-4-admission type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Encounter.patient",
"short": "The patient present at the encounter",
"definition": "The patient present at the encounter.",
"comments": "While the encounter is always about the patient, the patient may not actually be known in all contexts of use.",
"alias": [
"patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ]/role[classCode=PAT]"
}
]
},
{
"path": "Encounter.episodeOfCare",
"short": "An episode of care that this encounter should be recorded against",
"definition": "Where a specific encounter should be classified as a part of a specific episode of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as govt reporting, or issue tracking.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PV1-54, PV1-53"
}
]
},
{
"path": "Encounter.incomingReferralRequest",
"short": "Incoming Referral Request",
"definition": "The referral request that this encounter is satisfies (incoming referral).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "Encounter.participant",
"short": "List of participants involved in the encounter",
"definition": "The main practitioner responsible for providing the service.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ROL"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "Encounter.participant.type",
"short": "Role of participant in encounter",
"definition": "Role of participant in encounter.",
"comments": "The Participant Type indicates how an individual parcitipates in an encounter. It includes non practitioner participants, and for practitioners this is to describe the action type in the context of this encounter (e.g. Admitting Dr, Attending Dr, Translator, Consulting Dr). This is different to the Practitioner Roles which are functional roles, derived from terms of employment, education, licensing, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ParticipantType",
"strength": "required",
"description": "Role of participant in encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-participant-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ROL-3"
},
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "Encounter.participant.period",
"short": "Period of time during the encounter participant was present",
"definition": "The period of time that the specified participant was present during the encounter. These can overlap or be sub-sets of the overall encounters period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "ROL-5, ROL-6"
}
]
},
{
"path": "Encounter.participant.individual",
"short": "Persons involved in the encounter other than the patient",
"definition": "Persons involved in the encounter other than the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ROL-4"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Encounter.fulfills",
"short": "The appointment that scheduled this encounter",
"definition": "The appointment that scheduled this encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SCH-1-placer appointment ID / SCH-2-filler appointment ID"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=ENC, moodCode=APT]"
}
]
},
{
"path": "Encounter.period",
"short": "The start and end time of the encounter",
"definition": "The start and end time of the encounter.",
"comments": "If not (yet) known, the end of the Period may be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-44, PV1-45"
},
{
"identity": "rim",
"map": ".effectiveTime\n(low & high)"
}
]
},
{
"path": "Encounter.length",
"short": "Quantity of time the encounter lasted (less time absent)",
"definition": "Quantity of time the encounter lasted. This excludes the time during leaves of absence.",
"comments": "May differ from the time the Encounter.period lasted because of leave of absence.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "v2",
"map": "(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes"
},
{
"identity": "rim",
"map": ".lengthOfStayQuantity"
}
]
},
{
"path": "Encounter.reason",
"short": "Reason the encounter takes place (code)",
"definition": "Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EncounterReason",
"strength": "example",
"description": "Reason why the encounter takes place",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "EVN-4-event reason code / PV2-3-admit reason (note: PV2-3 is nominally constrained to inpatient admissions; V2.x makes no vocabulary suggestions for PV2-3; would not expect PV2 segment or PV2-3 to be in use in all implementations\n)"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "Encounter.indication",
"short": "Reason the encounter takes place (resource)",
"definition": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis.\nThe indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.",
"alias": [
"Admission diagnosis"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "Resources that would commonly referenced at Encounter.indication would be Condition and/or Procedure. These most closely align with DG1/PRB and PR1 respectively."
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target"
}
]
},
{
"path": "Encounter.priority",
"short": "Indicates the urgency of the encounter",
"definition": "Indicates the urgency of the encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Priority",
"strength": "example",
"description": "Indicates the urgency of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-priority"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV2-25-visit priority code"
},
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"path": "Encounter.hospitalization",
"short": "Details about an admission to a clinic",
"definition": "Details about an admission to a clinic.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Encounter.hospitalization.preAdmissionIdentifier",
"short": "Pre-admission identifier",
"definition": "Pre-admission identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-5-preadmit number"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Encounter.hospitalization.origin",
"short": "The location from which the patient came before admission",
"definition": "The location from which the patient came before admission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=ORG].role"
}
]
},
{
"path": "Encounter.hospitalization.admitSource",
"short": "From where patient was admitted (physician referral, transfer)",
"definition": "From where patient was admitted (physician referral, transfer).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "AdmitSource",
"strength": "required",
"description": "From where the patient was admitted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-admit-source"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-14-admit source"
},
{
"identity": "rim",
"map": ".admissionReferralSourceCode"
}
]
},
{
"path": "Encounter.hospitalization.diet",
"short": "Dietary restrictions for the patient",
"definition": "Dietary restrictions for the patient.",
"requirements": "Track patients reported dietary restrictions to help with catering requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "PatientDiet",
"strength": "example",
"description": "Medical, cultural or ethical food preferences to help with catering requirements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-diet"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-38-diet type"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=EVN, code=\"diet\"]"
}
]
},
{
"path": "Encounter.hospitalization.specialCourtesy",
"short": "Special courtesies (VIP, board member)",
"definition": "Special courtesies (VIP, board member).",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Courtesies",
"strength": "required",
"description": "Special courtesies",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-special-courtesy"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-16-VIP indicator"
},
{
"identity": "rim",
"map": ".specialCourtesiesCode"
}
]
},
{
"path": "Encounter.hospitalization.specialArrangement",
"short": "Wheelchair, translator, stretcher, etc",
"definition": "Wheelchair, translator, stretcher, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Arrangements",
"strength": "required",
"description": "Special arrangements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-special-arrangements"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-15-ambulatory status / OBR-30-transportation mode / OBR-43-planned patient transport comment"
},
{
"identity": "rim",
"map": ".specialArrangementCode"
}
]
},
{
"path": "Encounter.hospitalization.destination",
"short": "Location to which the patient is discharged",
"definition": "Location to which the patient is discharged.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-37"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST]"
}
]
},
{
"path": "Encounter.hospitalization.dischargeDisposition",
"short": "Category or kind of location after discharge",
"definition": "Category or kind of location after discharge.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DischargeDisp",
"strength": "required",
"description": "Discharge Disposition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-discharge-disposition"
}
},
"mapping": [
{
"identity": "v2",
"map": "PV1-36-discharge disposition"
},
{
"identity": "rim",
"map": ".dischargeDispositionCode"
}
]
},
{
"path": "Encounter.hospitalization.dischargeDiagnosis",
"short": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete",
"definition": "The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target[classCode=OBS, moodCode=EVN, code=ASSERTION].value"
}
]
},
{
"path": "Encounter.hospitalization.reAdmission",
"short": "Is this hospitalization a readmission?",
"definition": "Whether this hospitalization is a readmission.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-13-re-admission indicator"
},
{
"identity": "rim",
"map": "Propose at harmonization"
}
]
},
{
"path": "Encounter.location",
"short": "List of locations the patient has been at",
"definition": "List of locations at which the patient has been.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=LOC]"
}
]
},
{
"path": "Encounter.location.location",
"short": "Location the encounter takes place",
"definition": "The location where the encounter takes place.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-3-assigned patient location / PV1-6-prior patient location / PV1-11-temporary location / PV1-42-pending location / PV1-43-prior temporary location"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Encounter.location.status",
"short": "planned | present | reserved",
"definition": "The status of the participants presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EncounterLocationStatus",
"strength": "required",
"description": "The status of the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-location-status"
}
}
},
{
"path": "Encounter.location.period",
"short": "Time period during which the patient was present at the location",
"definition": "Time period during which the patient was present at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".time"
}
]
},
{
"path": "Encounter.serviceProvider",
"short": "The custodian organization of this Encounter record",
"definition": "An organization that is in charge of maintaining the information of this Encounter (e.g., who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location's Organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-10-hospital service / PL.6 Person Location Type & PL.1 Point of Care (note: V2.x definition is \"the treatment or type of surgery that the patient is scheduled to receive\"; seems slightly out of alignment with the concept name 'hospital service'. Would not trust that implementations apply this semantic by default)"
},
{
"identity": "rim",
"map": ".particiaption[typeCode=PFM].role"
}
]
},
{
"path": "Encounter.partOf",
"short": "Another Encounter this encounter is part of",
"definition": "Another Encounter of which this encounter is a part of (administratively or in time).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=COMP, moodCode=EVN]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "EnrollmentRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest",
"name": "EnrollmentRequest",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for EnrollmentRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "EnrollmentRequest",
"short": "Enrollment request",
"definition": "This resource provides the insurance Enrollment details to the insurer regarding a specified coverage.",
"min": 1,
"max": "1",
"type": [
{
"code": "EnrollmentRequest"
}
]
},
{
"path": "EnrollmentRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "EnrollmentRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "EnrollmentRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "EnrollmentRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "EnrollmentRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "EnrollmentRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentRequest.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EnrollmentRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EnrollmentRequest.target",
"short": "Insurer",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EnrollmentRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentRequest.subject",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "C06,C07,C08, C05, C04"
}
]
},
{
"path": "EnrollmentRequest.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "EnrollmentRequest.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "C03"
}
]
}
]
},
"differential": {
"element": [
{
"path": "EnrollmentRequest",
"short": "Enrollment request",
"definition": "This resource provides the insurance Enrollment details to the insurer regarding a specified coverage.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "EnrollmentRequest.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EnrollmentRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EnrollmentRequest.target",
"short": "Insurer",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EnrollmentRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentRequest.subject",
"short": "The subject of the Products and Services",
"definition": "Patient Resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "C06,C07,C08, C05, C04"
}
]
},
{
"path": "EnrollmentRequest.coverage",
"short": "Insurance information",
"definition": "Reference to the program or plan identification, underwriter or payor.",
"requirements": "Need to identify the issuer to target for processing and for coordination of benefit processing.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage"
}
]
},
{
"path": "EnrollmentRequest.relationship",
"short": "Patient relationship to subscriber",
"definition": "The relationship of the patient to the subscriber.",
"requirements": "To determine relationship between the patient and the subscriber.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Relationship",
"strength": "example",
"description": "The code for the relationship of the patient to the subscriber",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relationship"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "C03"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "EnrollmentResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/EnrollmentResponse",
"name": "EnrollmentResponse",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for EnrollmentResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "EnrollmentResponse",
"short": "EnrollmentResponse resource",
"definition": "This resource provides Enrollment and plan details from the processing of an Enrollment resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "EnrollmentResponse"
}
]
},
{
"path": "EnrollmentResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "EnrollmentResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "EnrollmentResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "EnrollmentResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "EnrollmentResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "EnrollmentResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EnrollmentResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EnrollmentResponse.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "EnrollmentResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "EnrollmentResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "EnrollmentResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EnrollmentResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EnrollmentResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
},
"differential": {
"element": [
{
"path": "EnrollmentResponse",
"short": "EnrollmentResponse resource",
"definition": "This resource provides Enrollment and plan details from the processing of an Enrollment resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "EnrollmentResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EnrollmentResponse.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EnrollmentRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "EnrollmentResponse.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "EnrollmentResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "EnrollmentResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "EnrollmentResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "EnrollmentResponse.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EnrollmentResponse.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "EnrollmentResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "EpisodeOfCare",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare",
"name": "EpisodeOfCare",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for EpisodeOfCare Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "EpisodeOfCare",
"short": "An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility",
"definition": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.",
"alias": [
"Case Program Problem"
],
"min": 1,
"max": "1",
"type": [
{
"code": "EpisodeOfCare"
}
]
},
{
"path": "EpisodeOfCare.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "EpisodeOfCare.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "EpisodeOfCare.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "EpisodeOfCare.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "EpisodeOfCare.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "EpisodeOfCare.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EpisodeOfCare.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EpisodeOfCare.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EpisodeOfCare.identifier",
"short": "Identifier(s) by which this EpisodeOfCare is known",
"definition": "Identifier(s) by which this EpisodeOfCare is known.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EpisodeOfCare.status",
"short": "planned | waitlist | active | onhold | finished | cancelled",
"definition": "planned | waitlist | active | onhold | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "EpisodeOfCareStatus",
"strength": "required",
"description": "The status of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/episode-of-care-status"
}
}
},
{
"path": "EpisodeOfCare.statusHistory",
"short": "The status history for the EpisodeOfCare",
"definition": "The status history for the EpisodeOfCare.",
"min": 0,
"max": "*"
},
{
"path": "EpisodeOfCare.statusHistory.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "EpisodeOfCare.statusHistory.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "EpisodeOfCare.statusHistory.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EpisodeOfCare.statusHistory.status",
"short": "planned | waitlist | active | onhold | finished | cancelled",
"definition": "planned | waitlist | active | onhold | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EpisodeOfCareStatus",
"strength": "required",
"description": "The status of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/episode-of-care-status"
}
}
},
{
"path": "EpisodeOfCare.statusHistory.period",
"short": "The period during this EpisodeOfCare that the specific status applied",
"definition": "The period during this EpisodeOfCare that the specific status applied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "EpisodeOfCare.type",
"short": "Specific type of EpisodeOfCare",
"definition": "The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.patient",
"short": "The patient that this EpisodeOfCare applies to",
"definition": "The patient that this EpisodeOfCare applies to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.managingOrganization",
"short": "The organization that has assumed the specific responsibilities for the specified duration",
"definition": "The organization that has assumed the specific responsibilities for the specified duration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.period",
"short": "The interval during which the managing organization assumes the defined responsibility",
"definition": "The interval during which the managing organization assumes the defined responsibility.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.condition",
"short": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for",
"definition": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
]
},
{
"path": "EpisodeOfCare.referralRequest",
"short": "Referral Request(s) that this EpisodeOfCare manages activities within",
"definition": "Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "EpisodeOfCare.careManager",
"short": "The practitioner that is the care manager/care co-ordinator for this patient",
"definition": "The practitioner that is the care manager/care co-ordinator for this patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "EpisodeOfCare.careTeam",
"short": "The list of practitioners that may be facilitating this episode of care for specific purposes",
"definition": "The list of practitioners that may be facilitating this episode of care for specific purposes.",
"min": 0,
"max": "*"
},
{
"path": "EpisodeOfCare.careTeam.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "EpisodeOfCare.careTeam.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "EpisodeOfCare.careTeam.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "EpisodeOfCare.careTeam.member",
"short": "The practitioner (or Organization) within the team",
"definition": "The practitioner (or Organization) within the team.",
"comments": "Where an Organization is included in the CareTeam, it is really providing some form of services to the EpisodeOfCare (e.g. Jim's Mowing Services) the details of the services would be included on a CarePlan.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EpisodeOfCare.careTeam.role",
"short": "The role that this team member is taking within this episode of care",
"definition": "The role that this team member is taking within this episode of care.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "EpisodeOfCare.careTeam.period",
"short": "The period of time that this practitioner is performing some role within the episode of care",
"definition": "The period of time that this practitioner is performing some role within the episode of care.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
},
"differential": {
"element": [
{
"path": "EpisodeOfCare",
"short": "An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility",
"definition": "An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.",
"alias": [
"Case Program Problem"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "EpisodeOfCare.identifier",
"short": "Identifier(s) by which this EpisodeOfCare is known",
"definition": "Identifier(s) by which this EpisodeOfCare is known.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "EpisodeOfCare.status",
"short": "planned | waitlist | active | onhold | finished | cancelled",
"definition": "planned | waitlist | active | onhold | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "EpisodeOfCareStatus",
"strength": "required",
"description": "The status of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/episode-of-care-status"
}
}
},
{
"path": "EpisodeOfCare.statusHistory",
"short": "The status history for the EpisodeOfCare",
"definition": "The status history for the EpisodeOfCare.",
"min": 0,
"max": "*"
},
{
"path": "EpisodeOfCare.statusHistory.status",
"short": "planned | waitlist | active | onhold | finished | cancelled",
"definition": "planned | waitlist | active | onhold | finished | cancelled.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "EpisodeOfCareStatus",
"strength": "required",
"description": "The status of the encounter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/episode-of-care-status"
}
}
},
{
"path": "EpisodeOfCare.statusHistory.period",
"short": "The period during this EpisodeOfCare that the specific status applied",
"definition": "The period during this EpisodeOfCare that the specific status applied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "EpisodeOfCare.type",
"short": "Specific type of EpisodeOfCare",
"definition": "The type can be very important in processing as this could be used in determining if the EpisodeOfCare is relevant to specific government reporting, or other types of classifications.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.patient",
"short": "The patient that this EpisodeOfCare applies to",
"definition": "The patient that this EpisodeOfCare applies to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.managingOrganization",
"short": "The organization that has assumed the specific responsibilities for the specified duration",
"definition": "The organization that has assumed the specific responsibilities for the specified duration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.period",
"short": "The interval during which the managing organization assumes the defined responsibility",
"definition": "The interval during which the managing organization assumes the defined responsibility.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true
},
{
"path": "EpisodeOfCare.condition",
"short": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for",
"definition": "A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
]
},
{
"path": "EpisodeOfCare.referralRequest",
"short": "Referral Request(s) that this EpisodeOfCare manages activities within",
"definition": "Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}
]
},
{
"path": "EpisodeOfCare.careManager",
"short": "The practitioner that is the care manager/care co-ordinator for this patient",
"definition": "The practitioner that is the care manager/care co-ordinator for this patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "EpisodeOfCare.careTeam",
"short": "The list of practitioners that may be facilitating this episode of care for specific purposes",
"definition": "The list of practitioners that may be facilitating this episode of care for specific purposes.",
"min": 0,
"max": "*"
},
{
"path": "EpisodeOfCare.careTeam.member",
"short": "The practitioner (or Organization) within the team",
"definition": "The practitioner (or Organization) within the team.",
"comments": "Where an Organization is included in the CareTeam, it is really providing some form of services to the EpisodeOfCare (e.g. Jim's Mowing Services) the details of the services would be included on a CarePlan.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "EpisodeOfCare.careTeam.role",
"short": "The role that this team member is taking within this episode of care",
"definition": "The role that this team member is taking within this episode of care.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "EpisodeOfCare.careTeam.period",
"short": "The period of time that this practitioner is performing some role within the episode of care",
"definition": "The period of time that this practitioner is performing some role within the episode of care.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ExplanationOfBenefit",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit",
"name": "ExplanationOfBenefit",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ExplanationOfBenefit Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ExplanationOfBenefit",
"short": "Remittance resource",
"definition": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.",
"alias": [
"EOB"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ExplanationOfBenefit"
}
]
},
{
"path": "ExplanationOfBenefit.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ExplanationOfBenefit.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ExplanationOfBenefit.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ExplanationOfBenefit.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ExplanationOfBenefit.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ExplanationOfBenefit.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ExplanationOfBenefit.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ExplanationOfBenefit.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ExplanationOfBenefit.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ExplanationOfBenefit.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ExplanationOfBenefit.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ExplanationOfBenefit.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ExplanationOfBenefit.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ExplanationOfBenefit.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ExplanationOfBenefit.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ExplanationOfBenefit.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ExplanationOfBenefit.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ExplanationOfBenefit.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ExplanationOfBenefit",
"short": "Remittance resource",
"definition": "This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.",
"alias": [
"EOB"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ExplanationOfBenefit.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ExplanationOfBenefit.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Claim"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ExplanationOfBenefit.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "ExplanationOfBenefit.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ExplanationOfBenefit.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ExplanationOfBenefit.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ExplanationOfBenefit.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ExplanationOfBenefit.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ExplanationOfBenefit.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ExplanationOfBenefit.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "FamilyHistory",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/FamilyHistory",
"name": "FamilyHistory",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for FamilyHistory Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "FamilyHistory",
"short": "Information about patient's relatives, relevant for patient",
"definition": "Significant health events and conditions for people related to the subject relevant in the context of care for the subject.",
"min": 1,
"max": "1",
"type": [
{
"code": "FamilyHistory"
}
],
"mapping": [
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "FamilyHistory.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "FamilyHistory.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "FamilyHistory.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "FamilyHistory.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "FamilyHistory.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "FamilyHistory.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "FamilyHistory.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "FamilyHistory.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "FamilyHistory.identifier",
"short": "External Id(s) for this record",
"definition": "This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "FamilyHistory.patient",
"short": "Patient history is about",
"definition": "The person who this history concerns.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
}
]
},
{
"path": "FamilyHistory.date",
"short": "When history was captured/updated",
"definition": "The date (and possibly time) when the family history was taken.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"path": "FamilyHistory.note",
"short": "Additional details not covered elsewhere",
"definition": "Conveys information about family history not specific to individual relations.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"path": "FamilyHistory.relation",
"short": "Relative described by history",
"definition": "The related person. Each FamilyHistory resource contains the entire family history for a single person.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "fhs-1",
"name": "Age or Birthdate",
"severity": "error",
"human": "Can have age[x] or birth[x], but not both",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRole"
}
]
},
{
"path": "FamilyHistory.relation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "FamilyHistory.relation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "FamilyHistory.relation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "FamilyHistory.relation.name",
"short": "The family member described",
"definition": "This will either be a name or a description. E.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "FamilyHistory.relation.relationship",
"short": "Relationship to the subject",
"definition": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "FamilialRelationship",
"strength": "required",
"description": "The nature of the relationship between the patient and the related person being described in the family history",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/FamilyMember"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "FamilyHistory.relation.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"path": "FamilyHistory.relation.age[x]",
"short": "(approximate) age",
"definition": "The actual or approximate age of the relative at the time the family history is recorded.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"path": "FamilyHistory.relation.deceased[x]",
"short": "Dead? How old/when?",
"definition": "If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG)\n\nFor age, you'd hang an observation off the role"
}
]
},
{
"path": "FamilyHistory.relation.note",
"short": "General note about related person",
"definition": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"path": "FamilyHistory.relation.condition",
"short": "Condition that the related person had",
"definition": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.",
"comments": "If none of the conditions listed have an outcome of \"death\" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"path": "FamilyHistory.relation.condition.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "FamilyHistory.relation.condition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "FamilyHistory.relation.condition.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "FamilyHistory.relation.condition.type",
"short": "Condition suffered by relation",
"definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "FamilyHistory.relation.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionOutcome",
"strength": "required",
"description": "The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"path": "FamilyHistory.relation.condition.onset[x]",
"short": "When condition first manifested",
"definition": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS']\n\nUse originalText for string"
}
]
},
{
"path": "FamilyHistory.relation.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
]
},
"differential": {
"element": [
{
"path": "FamilyHistory",
"short": "Information about patient's relatives, relevant for patient",
"definition": "Significant health events and conditions for people related to the subject relevant in the context of care for the subject.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "Not in scope for v2"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "FamilyHistory.identifier",
"short": "External Id(s) for this record",
"definition": "This records identifiers associated with this family history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "FamilyHistory.patient",
"short": "Patient history is about",
"definition": "The person who this history concerns.",
"alias": [
"Proband"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role"
}
]
},
{
"path": "FamilyHistory.date",
"short": "When history was captured/updated",
"definition": "The date (and possibly time) when the family history was taken.",
"requirements": "Allows determination of how current the summary is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"path": "FamilyHistory.note",
"short": "Additional details not covered elsewhere",
"definition": "Conveys information about family history not specific to individual relations.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"path": "FamilyHistory.relation",
"short": "Relative described by history",
"definition": "The related person. Each FamilyHistory resource contains the entire family history for a single person.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "fhs-1",
"name": "Age or Birthdate",
"severity": "error",
"human": "Can have age[x] or birth[x], but not both",
"xpath": "not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].role[classCode=PAT].player[classCode<LIV, moodCode=INSTANCE].scopedRole"
}
]
},
{
"path": "FamilyHistory.relation.name",
"short": "The family member described",
"definition": "This will either be a name or a description. E.g. \"Aunt Susan\", \"my cousin with the red hair\".",
"requirements": "Allows greater ease in ensuring the same person is being talked about.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "FamilyHistory.relation.relationship",
"short": "Relationship to the subject",
"definition": "The type of relationship this person has to the patient (father, mother, brother etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "FamilialRelationship",
"strength": "required",
"description": "The nature of the relationship between the patient and the related person being described in the family history",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/FamilyMember"
}
},
"mapping": [
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "FamilyHistory.relation.born[x]",
"short": "(approximate) date of birth",
"definition": "The actual or approximate date of birth of the relative.",
"requirements": "Allows calculation of the relative's age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "date"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE]. birthDate (could be URG)"
}
]
},
{
"path": "FamilyHistory.relation.age[x]",
"short": "(approximate) age",
"definition": "The actual or approximate age of the relative at the time the family history is recorded.",
"requirements": "While age can be calculated from date of birth, sometimes recording age directly is more natureal for clinicians.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"condition": [
"fhs-1"
],
"mapping": [
{
"identity": "rim",
"map": "participation[typeCode=SBJ].act[classCode=OBS,moodCode=EVN, code=\"age\"].value"
}
]
},
{
"path": "FamilyHistory.relation.deceased[x]",
"short": "Dead? How old/when?",
"definition": "If this resource is indicating that the related person is deceased, then an indicator of whether the person is deceased (yes) or not (no) or the age or age range or description of age at death - can be indicated here. If the reason for death is known, then it can be indicated in the outcome code of the condition - in this case the deceased property should still be set.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "date"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=LIV, determinerCode=INSTANCE].deceasedInd, deceasedDate (could be URG)\n\nFor age, you'd hang an observation off the role"
}
]
},
{
"path": "FamilyHistory.relation.note",
"short": "General note about related person",
"definition": "This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
},
{
"path": "FamilyHistory.relation.condition",
"short": "Condition that the related person had",
"definition": "The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.",
"comments": "If none of the conditions listed have an outcome of \"death\" specified, that indicates that none of the specified conditions are known to have been the primary cause of death.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION, value<Diagnosis]"
}
]
},
{
"path": "FamilyHistory.relation.condition.type",
"short": "Condition suffered by relation",
"definition": "The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like 'cancer' depending on how much is known about the condition and the capabilities of the creating system.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "FamilyHistory.relation.condition.outcome",
"short": "deceased | permanent disability | etc.",
"definition": "Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ConditionOutcome",
"strength": "required",
"description": "The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=OUTC)].target[classCode=OBS, moodCode=EVN, code=ActCode#ASSERTION].value"
}
]
},
{
"path": "FamilyHistory.relation.condition.onset[x]",
"short": "When condition first manifested",
"definition": "Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.",
"requirements": "Age of onset of a condition in relatives is predictive of risk for the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Age"
},
{
"code": "Range"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"Subject Age at measurement\", value<Diagnosis].value[@xsi:typeCode='TS' or 'IVL_TS']\n\nUse originalText for string"
}
]
},
{
"path": "FamilyHistory.relation.condition.note",
"short": "Extra information about condition",
"definition": "An area where general notes can be placed about this specific condition.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=ActCode#ANNGEN].value"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Goal",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Goal",
"name": "Goal",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Goal Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Goal",
"short": "Describes the intended objective(s) of patient care",
"definition": "Describes the intended objective(s) of patient care, for example, weight loss, restoring an activity of daily living, etc.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 1,
"max": "1",
"type": [
{
"code": "Goal"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "Goal.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Goal.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Goal.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Goal.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Goal.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Goal.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Goal.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Goal.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Goal.identifier",
"short": "External Ids for this goal",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Goal.patient",
"short": "The patient for whom this goal is intended for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Goals are associated with a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "Goal.description",
"short": "What's the desired outcome?",
"definition": "Human-readable description of a specific desired objective of care.",
"requirements": "Without a description of what's trying to be achieved, element has no purpose.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Goal.status",
"short": "proposed | planned | in-progress | achieved | sustaining | cancelled | accepted | rejected",
"definition": "Indicates whether the goal has been reached and is still considered relevant.",
"requirements": "Allows measuring outcome and whether goal needs to be further tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "GoalStatus",
"strength": "required",
"description": "Indicates whether the goal has been met and is still being targeted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/goal-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\rin-progress = active (classCode = OBJ)\rachieved = complete\rsustaining = active (classCode=OBJC)\rcancelled = aborted"
}
]
},
{
"path": "Goal.notes",
"short": "Comments about the goal",
"definition": "Any comments related to the goal.",
"comments": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Goal.concern",
"short": "Health issues this goal addresses",
"definition": "The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.",
"requirements": "Allows specific goals to explicitly linked to conditions - makes the goal more understandable.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Goal",
"short": "Describes the intended objective(s) of patient care",
"definition": "Describes the intended objective(s) of patient care, for example, weight loss, restoring an activity of daily living, etc.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"path": "Goal.identifier",
"short": "External Ids for this goal",
"definition": "This records identifiers associated with this care plan that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Goal.patient",
"short": "The patient for whom this goal is intended for",
"definition": "Identifies the patient/subject whose intended care is described by the plan.",
"requirements": "Goals are associated with a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"path": "Goal.description",
"short": "What's the desired outcome?",
"definition": "Human-readable description of a specific desired objective of care.",
"requirements": "Without a description of what's trying to be achieved, element has no purpose.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Goal.status",
"short": "proposed | planned | in-progress | achieved | sustaining | cancelled | accepted | rejected",
"definition": "Indicates whether the goal has been reached and is still considered relevant.",
"requirements": "Allows measuring outcome and whether goal needs to be further tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "GoalStatus",
"strength": "required",
"description": "Indicates whether the goal has been met and is still being targeted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/goal-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
},
{
"identity": "rim",
"map": ".statusCode\rin-progress = active (classCode = OBJ)\rachieved = complete\rsustaining = active (classCode=OBJC)\rcancelled = aborted"
}
]
},
{
"path": "Goal.notes",
"short": "Comments about the goal",
"definition": "Any comments related to the goal.",
"comments": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Goal.concern",
"short": "Health issues this goal addresses",
"definition": "The identified conditions that this goal relates to - the condition that caused it to be created, or that it is intended to address.",
"requirements": "Allows specific goals to explicitly linked to conditions - makes the goal more understandable.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Group",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Group",
"name": "Group",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Group Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Group",
"short": "Group of multiple entities",
"definition": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Group"
}
],
"constraint": [
{
"key": "grp-4",
"name": "No more members than quantity",
"severity": "error",
"human": "Can't have more members associated with the group than the value specified for \"quantity\"",
"xpath": "not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"
},
{
"key": "grp-1",
"name": "No members for non-actual",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"xpath": "f:actual/@value='true' or not(exists(f:member))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
}
]
},
{
"path": "Group.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Group.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Group.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Group.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Group.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Group.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Group.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Group.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Group.identifier",
"short": "Unique id",
"definition": "A unique business identifier for this group.",
"requirements": "Allows the group to be referenced.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
]
},
{
"path": "Group.type",
"short": "person | animal | practitioner | device | medication | substance",
"definition": "Identifies the broad classification of the kind of resources the group includes.",
"requirements": "Identifies what type of resources the group is made up of.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "GroupType",
"strength": "required",
"description": "Types of resources that are part of group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\"\n\nanimal: ./classCode=\"ANM\"\n\ndevice: ./classCode=\"DEV\"\n\nmedication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"]\n\nfood: ./classCode=\"FOOD\""
}
]
},
{
"path": "Group.actual",
"short": "Descriptive or actual",
"definition": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.",
"requirements": "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"condition": [
"grp-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\"\n\nfalse: ./determinerCode=\"GRP_KIND\""
}
]
},
{
"path": "Group.code",
"short": "Kind of Group members",
"definition": "Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc.",
"comments": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "GroupKind",
"strength": "required",
"description": "Kind of particular resource. E.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Group.name",
"short": "Label for Group",
"definition": "A label assigned to the group for human identification and communication.",
"requirements": "Used to identify the group in human communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
},
{
"path": "Group.quantity",
"short": "Number of members",
"definition": "A count of the number of resource instances that are part of the group.",
"requirements": "Group size is a common defining characteristic.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
},
{
"path": "Group.characteristic",
"short": "Trait of group members",
"definition": "Identifies the traits shared by members of the group.",
"requirements": "Needs to be a generic mechanism for identifying what individuals can be part of a group.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "Group.characteristic.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Group.characteristic.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Group.characteristic.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Group.characteristic.code",
"short": "Kind of characteristic",
"definition": "A code that identifies the kind of trait being asserted.",
"requirements": "Need a formal way of identifying the characteristic being described.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "GroupCharacteristicKind",
"strength": "required",
"description": "List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Group.characteristic.value[x]",
"short": "Value held by characteristic",
"definition": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comments": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"requirements": "The value of the characteristic is what determines group membership.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"binding": {
"name": "GroupCharacteristicValue",
"strength": "required",
"description": "Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
},
{
"path": "Group.characteristic.exclude",
"short": "Group includes or excludes",
"definition": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comments": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"requirements": "Sometimes group membership is determined by characteristics not possessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
},
{
"path": "Group.member",
"short": "Who or what is in group",
"definition": "Identifies the resource instances that are members of the group.",
"requirements": "Often the only thing of interest about a group is \"who's in it\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"condition": [
"grp-1"
],
"constraint": [
{
"key": "grp-3",
"name": "Group member type agreement",
"severity": "error",
"human": "Member resource types SHALL agree with group type",
"xpath": "lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"
}
],
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Group",
"short": "Group of multiple entities",
"definition": "Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "grp-4",
"name": "No more members than quantity",
"severity": "error",
"human": "Can't have more members associated with the group than the value specified for \"quantity\"",
"xpath": "not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"
},
{
"key": "grp-1",
"name": "No members for non-actual",
"severity": "error",
"human": "Can only have members if group is \"actual\"",
"xpath": "f:actual/@value='true' or not(exists(f:member))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
}
]
},
{
"path": "Group.identifier",
"short": "Unique id",
"definition": "A unique business identifier for this group.",
"requirements": "Allows the group to be referenced.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
]
},
{
"path": "Group.type",
"short": "person | animal | practitioner | device | medication | substance",
"definition": "Identifies the broad classification of the kind of resources the group includes.",
"requirements": "Identifies what type of resources the group is made up of.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "GroupType",
"strength": "required",
"description": "Types of resources that are part of group",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/group-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./classCode=\"PSN\"\n\nanimal: ./classCode=\"ANM\"\n\ndevice: ./classCode=\"DEV\"\n\nmedication: ./classCode=\"MMAT\" and ./playedRole[isNormalRole() and classCode=\"THER\"]\n\nfood: ./classCode=\"FOOD\""
}
]
},
{
"path": "Group.actual",
"short": "Descriptive or actual",
"definition": "If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.",
"requirements": "There are use-cases for groups that define specific collections of individuals, and other groups that define \"types\" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"condition": [
"grp-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true: ./determinerCode=\"GRP\"\n\nfalse: ./determinerCode=\"GRP_KIND\""
}
]
},
{
"path": "Group.code",
"short": "Kind of Group members",
"definition": "Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc.",
"comments": "This would generally be omitted for Person resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "GroupKind",
"strength": "required",
"description": "Kind of particular resource. E.g. cow, syringe, lake, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Group.name",
"short": "Label for Group",
"definition": "A label assigned to the group for human identification and communication.",
"requirements": "Used to identify the group in human communication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name[type=\"ST\"]"
}
]
},
{
"path": "Group.quantity",
"short": "Number of members",
"definition": "A count of the number of resource instances that are part of the group.",
"requirements": "Group size is a common defining characteristic.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./quantity"
}
]
},
{
"path": "Group.characteristic",
"short": "Trait of group members",
"definition": "Identifies the traits shared by members of the group.",
"requirements": "Needs to be a generic mechanism for identifying what individuals can be part of a group.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "Group.characteristic.code",
"short": "Kind of characteristic",
"definition": "A code that identifies the kind of trait being asserted.",
"requirements": "Need a formal way of identifying the characteristic being described.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "GroupCharacteristicKind",
"strength": "required",
"description": "List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Group.characteristic.value[x]",
"short": "Value held by characteristic",
"definition": "The value of the trait that holds (or does not hold - see 'exclude') for members of the group.",
"comments": "For Range, it means members of the group have a value that falls somewhere within the specified range.",
"requirements": "The value of the characteristic is what determines group membership.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "boolean"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"binding": {
"name": "GroupCharacteristicValue",
"strength": "required",
"description": "Value of descriptive member characteristic. E.g. red, male, pneumonia, caucasian, etc."
},
"mapping": [
{
"identity": "rim",
"map": "./value"
}
]
},
{
"path": "Group.characteristic.exclude",
"short": "Group includes or excludes",
"definition": "If true, indicates the characteristic is one that is NOT held by members of the group.",
"comments": "This is labeled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa.",
"requirements": "Sometimes group membership is determined by characteristics not possessed.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "./valueNegationInd"
}
]
},
{
"path": "Group.member",
"short": "Who or what is in group",
"definition": "Identifies the resource instances that are members of the group.",
"requirements": "Often the only thing of interest about a group is \"who's in it\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"condition": [
"grp-1"
],
"constraint": [
{
"key": "grp-3",
"name": "Group member type agreement",
"severity": "error",
"human": "Member resource types SHALL agree with group type",
"xpath": "lower-case(f:type/@value)=parent::f:Group/f:type/@value or (f:type/@value='Patient' and parent::f:Group/f:type/@value=('animal','person'))"
}
],
"mapping": [
{
"identity": "rim",
"map": "./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "HealthcareService",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
"name": "HealthcareService",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for HealthcareService Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "HealthcareService",
"short": "The details of a Healthcare Service available at a location",
"definition": "The details of a Healthcare Service available at a location.",
"min": 1,
"max": "1",
"type": [
{
"code": "HealthcareService"
}
]
},
{
"path": "HealthcareService.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "HealthcareService.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "HealthcareService.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "HealthcareService.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "HealthcareService.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "HealthcareService.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.identifier",
"short": "External Identifiers for this item",
"definition": "External Identifiers for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "HealthcareService.providedBy",
"short": "The organization that provides this Healthcare Service",
"definition": "The organization that provides this Healthcare Service.",
"comments": "This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such.\nIf the Location does not have a managing Organization, then this property should be populated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"path": "HealthcareService.location",
"short": "The location where this healthcare service may be provided",
"definition": "The location where this healthcare service may be provided.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceCategory",
"short": "Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type",
"definition": "Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceType",
"short": "A specific type of service that may be delivered or performed",
"definition": "A specific type of service that may be delivered or performed.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "HealthcareService.serviceType.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.serviceType.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.serviceType.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.serviceType.type",
"short": "The specific type of service being delivered or performed",
"definition": "The specific type of service being delivered or performed.",
"comments": "Change to serviceType?",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
}
},
{
"path": "HealthcareService.serviceType.specialty",
"short": "Collection of Specialties handled by the Service Site. This is more of a Medical Term",
"definition": "Collection of Specialties handled by the Service Site. This is more of a Medical Term.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceName",
"short": "Further description of the service as it would be presented to a consumer while searching",
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "HealthcareService.comment",
"short": "Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName",
"definition": "Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "HealthcareService.extraDetails",
"short": "Extra details about the service that can't be placed in the other fields",
"definition": "Extra details about the service that can't be placed in the other fields.",
"comments": "Can this just be removed, and extension if needed?",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.photo",
"short": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list",
"definition": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "HealthcareService.telecom",
"short": "List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts",
"definition": "List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
]
},
{
"path": "HealthcareService.coverageArea",
"short": "The location(s) that this service is available to (not where the service is provided)",
"definition": "The location(s) that this service is available to (not where the service is provided).",
"comments": "The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a Physical Area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as \"in-home\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "HealthcareService.eligibility",
"short": "Does this service have specific eligibility requirements that need to be met in order to use the service",
"definition": "Does this service have specific eligibility requirements that need to be met in order to use the service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.eligibilityNote",
"short": "Describes the eligibility conditions for the service",
"definition": "The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.programName",
"short": "Program Names that can be used to categorize the service",
"definition": "Program Names that can be used to categorize the service.",
"comments": "Programs are often defined externally to an Organization, commonly by governments. E.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.characteristic",
"short": "Collection of Characteristics (attributes)",
"definition": "Collection of Characteristics (attributes).",
"comments": "These could be such things as is wheelchair accessible.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.referralMethod",
"short": "Ways that the service accepts referrals",
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ReferralMethod",
"strength": "example",
"description": "The methods of referral can be used when referring to a specific HealthCareService resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-referral-method"
}
}
},
{
"path": "HealthcareService.publicKey",
"short": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available",
"definition": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.",
"comments": "Note: This is a base64 encoded digital certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.appointmentRequired",
"short": "Indicates if an appointment is required for access to this service",
"definition": "Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "HealthcareService.availableTime",
"short": "A Collection of times that the Service Site is available",
"definition": "A Collection of times that the Service Site is available.",
"comments": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min": 0,
"max": "*"
},
{
"path": "HealthcareService.availableTime.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.availableTime.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.availableTime.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.availableTime.daysOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "Indicates which Days of the week are available between the Start and End Times.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.availableTime.allDay",
"short": "Is this always available? (hence times are irrelevant) e.g. 24 hour service",
"definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "HealthcareService.availableTime.availableStartTime",
"short": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored",
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comments": "The timezone is expected to be that of the location this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
]
},
{
"path": "HealthcareService.availableTime.availableEndTime",
"short": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored",
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comments": "The timezone is expected to be that of the location this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
]
},
{
"path": "HealthcareService.notAvailable",
"short": "The HealthcareService is not available during this period of time due to the provided reason",
"definition": "The HealthcareService is not available during this period of time due to the provided reason.",
"min": 0,
"max": "*"
},
{
"path": "HealthcareService.notAvailable.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.notAvailable.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "HealthcareService.notAvailable.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "HealthcareService.notAvailable.description",
"short": "The reason that can be presented to the user as to why this time is not available",
"definition": "The reason that can be presented to the user as to why this time is not available.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.notAvailable.during",
"short": "Service is not available (seasonally or for a public holiday) from this date",
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "HealthcareService.availabilityExceptions",
"short": "A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times",
"definition": "A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times.",
"comments": "(May contain HTML formatted text).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"path": "HealthcareService",
"short": "The details of a Healthcare Service available at a location",
"definition": "The details of a Healthcare Service available at a location.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "HealthcareService.identifier",
"short": "External Identifiers for this item",
"definition": "External Identifiers for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "HealthcareService.providedBy",
"short": "The organization that provides this Healthcare Service",
"definition": "The organization that provides this Healthcare Service.",
"comments": "This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such.\nIf the Location does not have a managing Organization, then this property should be populated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"path": "HealthcareService.location",
"short": "The location where this healthcare service may be provided",
"definition": "The location where this healthcare service may be provided.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceCategory",
"short": "Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type",
"definition": "Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceType",
"short": "A specific type of service that may be delivered or performed",
"definition": "A specific type of service that may be delivered or performed.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "HealthcareService.serviceType.type",
"short": "The specific type of service being delivered or performed",
"definition": "The specific type of service being delivered or performed.",
"comments": "Change to serviceType?",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
}
},
{
"path": "HealthcareService.serviceType.specialty",
"short": "Collection of Specialties handled by the Service Site. This is more of a Medical Term",
"definition": "Collection of Specialties handled by the Service Site. This is more of a Medical Term.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true
},
{
"path": "HealthcareService.serviceName",
"short": "Further description of the service as it would be presented to a consumer while searching",
"definition": "Further description of the service as it would be presented to a consumer while searching.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "HealthcareService.comment",
"short": "Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName",
"definition": "Additional description of the or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "HealthcareService.extraDetails",
"short": "Extra details about the service that can't be placed in the other fields",
"definition": "Extra details about the service that can't be placed in the other fields.",
"comments": "Can this just be removed, and extension if needed?",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.photo",
"short": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list",
"definition": "If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"isSummary": true
},
{
"path": "HealthcareService.telecom",
"short": "List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts",
"definition": "List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
]
},
{
"path": "HealthcareService.coverageArea",
"short": "The location(s) that this service is available to (not where the service is provided)",
"definition": "The location(s) that this service is available to (not where the service is provided).",
"comments": "The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a Physical Area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as \"in-home\".",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
]
},
{
"path": "HealthcareService.eligibility",
"short": "Does this service have specific eligibility requirements that need to be met in order to use the service",
"definition": "Does this service have specific eligibility requirements that need to be met in order to use the service.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.eligibilityNote",
"short": "Describes the eligibility conditions for the service",
"definition": "The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.programName",
"short": "Program Names that can be used to categorize the service",
"definition": "Program Names that can be used to categorize the service.",
"comments": "Programs are often defined externally to an Organization, commonly by governments. E.g. Home and Community Care Programs, Homeless Program, ….",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.characteristic",
"short": "Collection of Characteristics (attributes)",
"definition": "Collection of Characteristics (attributes).",
"comments": "These could be such things as is wheelchair accessible.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.referralMethod",
"short": "Ways that the service accepts referrals",
"definition": "Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ReferralMethod",
"strength": "example",
"description": "The methods of referral can be used when referring to a specific HealthCareService resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/service-referral-method"
}
}
},
{
"path": "HealthcareService.publicKey",
"short": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available",
"definition": "The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available.",
"comments": "Note: This is a base64 encoded digital certificate.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.appointmentRequired",
"short": "Indicates if an appointment is required for access to this service",
"definition": "Indicates whether or not a prospective consumer will require an appointment for a particular service at a Site to be provided by the Organization. Indicates if an appointment is required for access to this service.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "HealthcareService.availableTime",
"short": "A Collection of times that the Service Site is available",
"definition": "A Collection of times that the Service Site is available.",
"comments": "More detailed availability information may be provided in associated Schedule/Slot resources.",
"min": 0,
"max": "*"
},
{
"path": "HealthcareService.availableTime.daysOfWeek",
"short": "mon | tue | wed | thu | fri | sat | sun",
"definition": "Indicates which Days of the week are available between the Start and End Times.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"path": "HealthcareService.availableTime.allDay",
"short": "Is this always available? (hence times are irrelevant) e.g. 24 hour service",
"definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "HealthcareService.availableTime.availableStartTime",
"short": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored",
"definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comments": "The timezone is expected to be that of the location this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
]
},
{
"path": "HealthcareService.availableTime.availableEndTime",
"short": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored",
"definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"comments": "The timezone is expected to be that of the location this HealthcareService is provided at.",
"min": 0,
"max": "1",
"type": [
{
"code": "time"
}
]
},
{
"path": "HealthcareService.notAvailable",
"short": "The HealthcareService is not available during this period of time due to the provided reason",
"definition": "The HealthcareService is not available during this period of time due to the provided reason.",
"min": 0,
"max": "*"
},
{
"path": "HealthcareService.notAvailable.description",
"short": "The reason that can be presented to the user as to why this time is not available",
"definition": "The reason that can be presented to the user as to why this time is not available.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "HealthcareService.notAvailable.during",
"short": "Service is not available (seasonally or for a public holiday) from this date",
"definition": "Service is not available (seasonally or for a public holiday) from this date.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "HealthcareService.availabilityExceptions",
"short": "A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times",
"definition": "A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times.",
"comments": "(May contain HTML formatted text).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ImagingObjectSelection",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ImagingObjectSelection",
"name": "ImagingObjectSelection",
"publisher": "HL7 FHIR Project (Imaging Integration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ImagingObjectSelection Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ImagingObjectSelection",
"short": "Key Object Selection",
"definition": "A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient.",
"requirements": "A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.",
"alias": [
"ImageManifest\nKeyImageNote"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ImagingObjectSelection"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
}
]
},
{
"path": "ImagingObjectSelection.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ImagingObjectSelection.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ImagingObjectSelection.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ImagingObjectSelection.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ImagingObjectSelection.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ImagingObjectSelection.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.uid",
"short": "Instance UID",
"definition": "Instance UID of the DICOM KOS SOP Instances represenetd in this resource.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingObjectSelection.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection.",
"comments": "SOP instances selected in the key object selection can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in key object selection must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name\n(0010,0020) - Patient ID\n(0010,0021) - Issuer of Patient ID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingObjectSelection.title",
"short": "Reason for selection",
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"comments": "Coded concept of kind of the key object selection. Value set is defined in the DICOM standard CID-7010.\n\nhttp://medical.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html.",
"requirements": "Need to represent the application purpose that the SOP instances in key object selection are selected for.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "KOStitle",
"strength": "example",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/kos-title"
}
},
"mapping": [
{
"identity": "dicom",
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item"
}
]
},
{
"path": "ImagingObjectSelection.description",
"short": "Description text",
"definition": "Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"comments": "Free text narrative description of the key object selection.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A160) - Text Value\nSR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"path": "ImagingObjectSelection.author",
"short": "Author (human or machine)",
"definition": "Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"comments": "Author of the key object selection. This can be a human author or a device author. Human author is represented with the HumanName type. Device author is represented with a reference to the Device resource.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence\nTID 1002 - Observer Context"
}
]
},
{
"path": "ImagingObjectSelection.authoringTime",
"short": "Authoring time of the selection",
"definition": "Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource.",
"comments": "Authoring time.",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingObjectSelection.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comments": "Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.study.uid",
"short": "Study instance uid",
"definition": "Study instance uid of the SOP instances in the selection.",
"requirements": "Study instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.",
"comments": "Study level locator information is optional. If provided, this is the URL to retrieve the entire study with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire study using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series",
"short": "Series identity of the selected instances",
"definition": "Series indetity and locating information of the DICOM SOP instances in the selection.",
"comments": "Series component represents the series level indentity and locator information of the DICOM SOP instances in the selection.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.study.series.uid",
"short": "Series instance uid",
"definition": "Series instance uid of the SOP instances in the selection.",
"requirements": "Series instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection.",
"comments": "Series level locator information is optional. If provided, this is the URL to retrieve the entire series with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire series using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comments": "SOP Instance component identify the instance selected in the selection, along with the study and series identities to form the DICOM identity hierachy.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.sopClass",
"short": "SOP class uid of instance",
"definition": "SOP class uid of the selected instance.",
"comments": "SOP class uid provides the type of the selected instances, e.g., CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"requirements": "DICOM SOP instance can be an imaging or other data object. The SOP class uid provide the accurate information about what type the instance is.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.uid",
"short": "Uid of the selected instance",
"definition": "SOP Instance uid of the selected instance.",
"comments": "SOP instance uid identifies the instance.",
"requirements": "SOP instance uid is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM SOP Instance.",
"comments": "Instance level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the SOP instance using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames",
"short": "The frame set",
"definition": "Identity and location information of the frames in the selected instance.",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"requirements": "The DICOM frames for a given study, series, SOP Instance UID, and frame numbers. The retrieveUrl retrieves the pixel data, and is encapsulated in a multipart MIME response.",
"min": 0,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.frameNumbers",
"short": "Frame numbers",
"definition": "The frame numbers in the frame set.",
"requirements": "one or more non duplicate frame numbers.",
"min": 1,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM frames.",
"comments": "Frame level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the frames using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "WADO-RS - RetrieveFrames"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ImagingObjectSelection",
"short": "Key Object Selection",
"definition": "A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient.",
"requirements": "A FHIR representation of DICOM Key Object Selection (KOS) SOP Instances enables access to a set of selected DICOM SOP Instances.",
"alias": [
"ImageManifest\nKeyImageNote"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Key Object Selection SOP Class (1.2.840.10008.5.1.4.1.1.88.59)"
}
]
},
{
"path": "ImagingObjectSelection.uid",
"short": "Instance UID",
"definition": "Instance UID of the DICOM KOS SOP Instances represenetd in this resource.",
"requirements": "DICOM SOP Instance is always assigned with a unique identifier (UID).",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID (of the Key Object Selection SOP Class)"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingObjectSelection.patient",
"short": "Patient of the selected objects",
"definition": "A patient resource reference which is the patient subject of all DICOM SOP Instances in this key object selection.",
"comments": "SOP instances selected in the key object selection can be from different studies, but must be of the same patient.",
"requirements": "SOP Instances in key object selection must be from the same patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0010,0010) - Patient Name\n(0010,0020) - Patient ID\n(0010,0021) - Issuer of Patient ID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingObjectSelection.title",
"short": "Reason for selection",
"definition": "The reason for, or significance of, the selection of objects referenced in the resource.",
"comments": "Coded concept of kind of the key object selection. Value set is defined in the DICOM standard CID-7010.\n\nhttp://medical.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html.",
"requirements": "Need to represent the application purpose that the SOP instances in key object selection are selected for.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "KOStitle",
"strength": "example",
"description": "The document title code of key object selection",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/kos-title"
}
},
"mapping": [
{
"identity": "dicom",
"map": "(0040,A043) - Concept Name Code Sequence in the SR root item"
}
]
},
{
"path": "ImagingObjectSelection.description",
"short": "Description text",
"definition": "Text description of the DICOM SOP instances selected in the key object selection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection.",
"comments": "Free text narrative description of the key object selection.",
"requirements": "Need to provide a narrative description of the SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A160) - Text Value\nSR content item immediately under the root item, concept name code = (113012, DCM, \"Key Object Description\")"
}
]
},
{
"path": "ImagingObjectSelection.author",
"short": "Author (human or machine)",
"definition": "Author of key object selection. It can be a human authtor or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attached in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.",
"comments": "Author of the key object selection. This can be a human author or a device author. Human author is represented with the HumanName type. Device author is represented with a reference to the Device resource.",
"requirements": "Track the selection decision maker.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A730) - Content Sequence\nTID 1002 - Observer Context"
}
]
},
{
"path": "ImagingObjectSelection.authoringTime",
"short": "Authoring time of the selection",
"definition": "Date and time when the key object selection was authored. Note that this is the date and time the DICOM SOP instances in the selection were selected (selection decision making). It is different from the creation date and time of the selection resource.",
"comments": "Authoring time.",
"requirements": "Date and time when the selection was made can be important to understand the content of selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0040,A032) - Observation Date Time"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingObjectSelection.study",
"short": "Study identity of the selected instances",
"definition": "Study identity and locating information of the DICOM SOP instances in the selection.",
"comments": "Study component represents the study level identity and locator information of the DICOM SOP instances in the selection. It is the top level identity of the hierachical identification of the instances.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the study level provide a means of retrieving the entire study.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.uid",
"short": "Study instance uid",
"definition": "Study instance uid of the SOP instances in the selection.",
"requirements": "Study instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000D) - Study Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection.",
"comments": "Study level locator information is optional. If provided, this is the URL to retrieve the entire study with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire study using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series",
"short": "Series identity of the selected instances",
"definition": "Series indetity and locating information of the DICOM SOP instances in the selection.",
"comments": "Series component represents the series level indentity and locator information of the DICOM SOP instances in the selection.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. In addition, the locator at the series level provide a means of retrieving the entire series.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.uid",
"short": "Series instance uid",
"definition": "Series instance uid of the SOP instances in the selection.",
"requirements": "Series instance uid is required to fully identify the DICOM SOP instances in the selection.",
"min": 0,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,000E) - Series Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the series Note that this URL retrieves all SOP instances of the series not only those in the selection.",
"comments": "Series level locator information is optional. If provided, this is the URL to retrieve the entire series with WADO-RS interaction, though only a subset of these are selected in the selection.",
"requirements": "WADO-RS URL enables retrieval of the entire series using DICOM WADO-RS API.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance",
"short": "The selected instance",
"definition": "Identity and locating information of the selected DICOM SOP instances.",
"comments": "SOP Instance component identify the instance selected in the selection, along with the study and series identities to form the DICOM identity hierachy.",
"requirements": "DICOM SOP instances are identified through the UIDs of the study - series - instance hierarchy. This is the instance level identity of the instance in the selection.",
"min": 1,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.sopClass",
"short": "SOP class uid of instance",
"definition": "SOP class uid of the selected instance.",
"comments": "SOP class uid provides the type of the selected instances, e.g., CT image, Gray scale softcopy presentation state, ECG waveform, etc.",
"requirements": "DICOM SOP instance can be an imaging or other data object. The SOP class uid provide the accurate information about what type the instance is.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0016) SOP Class UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.uid",
"short": "Uid of the selected instance",
"definition": "SOP Instance uid of the selected instance.",
"comments": "SOP instance uid identifies the instance.",
"requirements": "SOP instance uid is required to fully identify the DICOM SOP instance in the selection.",
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,0018) - SOP Instance UID"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM SOP Instance.",
"comments": "Instance level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the SOP instance using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0008,1190) - Retrieve URL"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames",
"short": "The frame set",
"definition": "Identity and location information of the frames in the selected instance.",
"comments": "This component may be used if the referenced image SOP Instance is a multi-frame image.",
"requirements": "The DICOM frames for a given study, series, SOP Instance UID, and frame numbers. The retrieveUrl retrieves the pixel data, and is encapsulated in a multipart MIME response.",
"min": 0,
"max": "*"
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.frameNumbers",
"short": "Frame numbers",
"definition": "The frame numbers in the frame set.",
"requirements": "one or more non duplicate frame numbers.",
"min": 1,
"max": "*",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ImagingObjectSelection.study.series.instance.frames.url",
"short": "Retrieve URL",
"definition": "WADO-RS URL to retrieve the DICOM frames.",
"comments": "Frame level locator information is required.",
"requirements": "WADO-RS URL enables retrieval of the frames using DICOM WADO-RS API.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "WADO-RS - RetrieveFrames"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ImagingStudy",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"name": "ImagingStudy",
"publisher": "HL7 FHIR Project (Imaging Integration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/imagemgt/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ImagingStudy Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ImagingStudy",
"short": "A set of images produced in single study (one or more series of references images)",
"definition": "Representation of the content produced in a DICOM imaging study. A study comprises a set of Series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A Series is of only one modality (e.g., X-ray, CT, MR, ultrasound), but a Study may have multiple Series of different modalities.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ImagingStudy"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14.1"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ImagingStudy.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ImagingStudy.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ImagingStudy.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ImagingStudy.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ImagingStudy.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.started",
"short": "When the study was started (0008,0020)+(0008,0030)",
"definition": "Date and Time the study started. Timezone Offset From UTC.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"exampleDateTime": "2011-01-01T11:01:20+03:00",
"mapping": [
{
"identity": "dicom",
"map": "0008,0020+0008,0030"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0010/*"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingStudy.uid",
"short": "Formal identifier for the study (0020,000D)",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
"mapping": [
{
"identity": "dicom",
"map": "0020,000D"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.accession",
"short": "Accession Number (0008,0050)",
"definition": "Accession Number.",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0050"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study (0020,0010)",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,0010"
},
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
}
]
},
{
"path": "ImagingStudy.order",
"short": "Order(s) that caused this study to be performed",
"definition": "A list of the diagnostic orders that resulted in this imaging study being performed.",
"requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g., chest/abdomen/pelvis CT).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
}
]
},
{
"path": "ImagingStudy.modalityList",
"short": "All series.modality if actual acquisition modalities",
"definition": "A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).",
"alias": [
"ModalitiesInStudy"
],
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ImagingModality",
"strength": "required",
"description": "Type of acquired image data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/imaging-modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0061"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.referrer",
"short": "Referring physician (0008,0090)",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0090"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
}
]
},
{
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"path": "ImagingStudy.url",
"short": "Retrieve URI (0008,1190)",
"definition": "WADO-RS resource where Study is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series (0020,1206)",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1206)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances (0020,1208)",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1208)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.clinicalInformation",
"short": "Diagnoses etc with request (0040,1002)",
"definition": "Diagnoses etc provided with request.",
"alias": [
"AdmittingDiagnosesDescription",
"AdditionalPatientHistory"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0040,1002, 0008,1080"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target"
}
]
},
{
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed (0008,1032)",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images (0008,1060)",
"definition": "Who read study and interpreted the images.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1060"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"path": "ImagingStudy.description",
"short": "Institution-generated description (0008,1030)",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1030"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of image instances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingStudy.series.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingStudy.series.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series (0020,0011)",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"exampleInteger": 3,
"mapping": [
{
"identity": "dicom",
"map": "0020,0011"
},
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series (0008,0060)",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"exampleCode": "CT",
"binding": {
"name": "Modality",
"strength": "required",
"description": "Type of data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.uid",
"short": "Formal identifier for this series (0020,000E)",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"mapping": [
{
"identity": "dicom",
"map": "0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.description",
"short": "A description of the series (0008,103E)",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "CT Surview 180",
"mapping": [
{
"identity": "dicom",
"map": "0008,103E"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances (0020,1209)",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,1209"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
}
]
},
{
"path": "ImagingStudy.series.url",
"short": "Retrieve URI (0008,1115 > 0008,1190)",
"definition": "WADO-RS resource where the Series is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1115 > 0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined (Map from 0018,0015)",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0018,0015"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if bodySite is paired anatomic structure and laterality is not pre-coordinated in bodySite code, map from (0020, 0060).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "200060"
}
]
},
{
"path": "ImagingStudy.series.dateTime",
"short": "When the series started",
"definition": "The date and time when the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.series.instance",
"short": "A single instance taken from a patient (image or other)",
"definition": "A single SOP Instance within the series, e.g., an image, or presentation state.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.instance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingStudy.series.instance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImagingStudy.series.instance.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series (0020,0013)",
"definition": "The number of this image in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"exampleInteger": 1,
"mapping": [
{
"identity": "dicom",
"map": "0020,0013"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.instance.uid",
"short": "Formal identifier for this instance (0008,0018)",
"definition": "Formal identifier for this image.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
"mapping": [
{
"identity": "dicom",
"map": "0008,0018"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.instance.sopclass",
"short": "DICOM class type (0008,0016)",
"definition": "DICOM Image type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
"mapping": [
{
"identity": "dicom",
"map": "0008,0016"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
}
]
},
{
"path": "ImagingStudy.series.instance.type",
"short": "Type of instance (image etc) (0004,1430)",
"definition": "A human-friendly SOP Class name.",
"comments": "E.g., 'CT image', 'MR multi-frame', 'blending presentation'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0004,1430"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.instance.title",
"short": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)",
"definition": "The description of the instance.",
"comments": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImagingStudy.series.instance.content",
"short": "Content of the instance",
"definition": "Content of the instance or a rendering thereof (e.g., a JPEG of an image, or an XML of a structured report). May be represented by inline encoding, or by a URL reference to a WADO-RS service that makes the instance available. Multiple content attachments may be used for alternate representations of the instance.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The attachment is a reference to a FHIR resource (Media, Document, etc).",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text.binary"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ImagingStudy",
"short": "A set of images produced in single study (one or more series of references images)",
"definition": "Representation of the content produced in a DICOM imaging study. A study comprises a set of Series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A Series is of only one modality (e.g., X-ray, CT, MR, ultrasound), but a Study may have multiple Series of different modalities.",
"alias": [
"Manifest",
"XDS-I summary",
"Key Images"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dicom",
"map": "Reference IHE radiology TF vol 2 table 4.14.1"
},
{
"identity": "rim",
"map": "Act[classCode=COMPOSITION, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.started",
"short": "When the study was started (0008,0020)+(0008,0030)",
"definition": "Date and Time the study started. Timezone Offset From UTC.",
"alias": [
"StudyDate",
"StudyTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"exampleDateTime": "2011-01-01T11:01:20+03:00",
"mapping": [
{
"identity": "dicom",
"map": "0008,0020+0008,0030"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.patient",
"short": "Who the images are of",
"definition": "The patient imaged in the study.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0010/*"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "ImagingStudy.uid",
"short": "Formal identifier for the study (0020,000D)",
"definition": "Formal identifier for the study.",
"alias": [
"StudyInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045",
"mapping": [
{
"identity": "dicom",
"map": "0020,000D"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.accession",
"short": "Accession Number (0008,0050)",
"definition": "Accession Number.",
"alias": [
"AccessionNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0050"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "ImagingStudy.identifier",
"short": "Other identifiers for the study (0020,0010)",
"definition": "Other identifiers for the study.",
"alias": [
"StudyID"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,0010"
},
{
"identity": "rim",
"map": ".id (no means to distinguish from uid)"
}
]
},
{
"path": "ImagingStudy.order",
"short": "Order(s) that caused this study to be performed",
"definition": "A list of the diagnostic orders that resulted in this imaging study being performed.",
"requirements": "To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g., chest/abdomen/pelvis CT).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO]"
}
]
},
{
"path": "ImagingStudy.modalityList",
"short": "All series.modality if actual acquisition modalities",
"definition": "A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).",
"alias": [
"ModalitiesInStudy"
],
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ImagingModality",
"strength": "required",
"description": "Type of acquired image data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/imaging-modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0061"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.referrer",
"short": "Referring physician (0008,0090)",
"definition": "The requesting/referring physician.",
"alias": [
"ReferringPhysiciansName"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,0090"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[classCode=DGIMG, moodCode=RQO].participation[typeCode=AUT].role"
}
]
},
{
"path": "ImagingStudy.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of study (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": "Not supported"
}
]
},
{
"path": "ImagingStudy.url",
"short": "Retrieve URI (0008,1190)",
"definition": "WADO-RS resource where Study is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.numberOfSeries",
"short": "Number of Study Related Series (0020,1206)",
"definition": "Number of Series in Study.",
"alias": [
"NumberOfStudyRelatedSeries"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1206)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=OBSSER, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.numberOfInstances",
"short": "Number of Study Related Instances (0020,1208)",
"definition": "Number of SOP Instances in Study.",
"alias": [
"NumberOfStudyRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "(0020,1208)"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.clinicalInformation",
"short": "Diagnoses etc with request (0040,1002)",
"definition": "Diagnoses etc provided with request.",
"alias": [
"AdmittingDiagnosesDescription",
"AdditionalPatientHistory"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0040,1002, 0008,1080"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target"
}
]
},
{
"path": "ImagingStudy.procedure",
"short": "Type of procedure performed (0008,1032)",
"definition": "Type of procedure performed.",
"alias": [
"ProcedureCodeSequence"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=PROC, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.interpreter",
"short": "Who interpreted images (0008,1060)",
"definition": "Who read study and interpreted the images.",
"alias": [
"Name of Physician(s) Reading Study"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1060"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role"
}
]
},
{
"path": "ImagingStudy.description",
"short": "Institution-generated description (0008,1030)",
"definition": "Institution-generated description or classification of the Study performed.",
"alias": [
"StudyDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1030"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series",
"short": "Each study has one or more series of instances",
"definition": "Each study has one or more series of image instances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBSSER, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.number",
"short": "Numeric identifier of this series (0020,0011)",
"definition": "The Numeric identifier of this series in the study.",
"alias": [
"SeriesNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"exampleInteger": 3,
"mapping": [
{
"identity": "dicom",
"map": "0020,0011"
},
{
"identity": "rim",
"map": ".inboundRelationship[type=COMP, source[classCode=COMPOSITION, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.modality",
"short": "The modality of the instances in the series (0008,0060)",
"definition": "The modality of this series sequence.",
"alias": [
"Modality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"exampleCode": "CT",
"binding": {
"name": "Modality",
"strength": "required",
"description": "Type of data in the instance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modality"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.uid",
"short": "Formal identifier for this series (0020,000E)",
"definition": "Formal identifier for this series.",
"alias": [
"SeriesInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630",
"mapping": [
{
"identity": "dicom",
"map": "0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.description",
"short": "A description of the series (0008,103E)",
"definition": "A description of the series.",
"alias": [
"SeriesDescription"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "CT Surview 180",
"mapping": [
{
"identity": "dicom",
"map": "0008,103E"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImagingStudy.series.numberOfInstances",
"short": "Number of Series Related Instances (0020,1209)",
"definition": "Number of SOP Instances in Series.",
"alias": [
"NumberOfSeriesRelatedInstances"
],
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0020,1209"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target[classCode=DGIMG, moodCode=EVN].repeatNumber"
}
]
},
{
"path": "ImagingStudy.series.availability",
"short": "ONLINE | OFFLINE | NEARLINE | UNAVAILABLE (0008,0056)",
"definition": "Availability of series (online, offline or nearline).",
"alias": [
"InstanceAvailability"
],
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "InstanceAvailability",
"strength": "required",
"description": "Availability of the resource",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/instance-availability"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0056"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"availability\"].value"
}
]
},
{
"path": "ImagingStudy.series.url",
"short": "Retrieve URI (0008,1115 > 0008,1190)",
"definition": "WADO-RS resource where the Series is available.",
"alias": [
"RetrieveURI"
],
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0008,1115 > 0008,1190"
},
{
"identity": "rim",
"map": ".text.reference"
}
]
},
{
"path": "ImagingStudy.series.bodySite",
"short": "Body part examined (Map from 0018,0015)",
"definition": "Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.",
"alias": [
"BodyPartExamined"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0018,0015"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "ImagingStudy.series.laterality",
"short": "Body part laterality",
"definition": "Laterality if bodySite is paired anatomic structure and laterality is not pre-coordinated in bodySite code, map from (0020, 0060).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "dicom",
"map": "200060"
}
]
},
{
"path": "ImagingStudy.series.dateTime",
"short": "When the series started",
"definition": "The date and time when the series was started.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "ImagingStudy.series.instance",
"short": "A single instance taken from a patient (image or other)",
"definition": "A single SOP Instance within the series, e.g., an image, or presentation state.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DGIMG, moodCode=EVN]"
}
]
},
{
"path": "ImagingStudy.series.instance.number",
"short": "The number of this instance in the series (0020,0013)",
"definition": "The number of this image in the series.",
"alias": [
"InstanceNumber"
],
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"exampleInteger": 1,
"mapping": [
{
"identity": "dicom",
"map": "0020,0013"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, source[classCode=OBSSER, moodCode=EVN]].sequenceNumber"
}
]
},
{
"path": "ImagingStudy.series.instance.uid",
"short": "Formal identifier for this instance (0008,0018)",
"definition": "Formal identifier for this image.",
"alias": [
"SOPInstanceUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903",
"mapping": [
{
"identity": "dicom",
"map": "0008,0018"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImagingStudy.series.instance.sopclass",
"short": "DICOM class type (0008,0016)",
"definition": "DICOM Image type.",
"alias": [
"SOPClassUID"
],
"min": 1,
"max": "1",
"type": [
{
"code": "oid"
}
],
"exampleUri": "urn:oid:1.2.840.10008.5.1.4.1.1.2",
"mapping": [
{
"identity": "dicom",
"map": "0008,0016"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP]. source[classCode=OBS, moodCode=EVN, code=\"sop class\"].value"
}
]
},
{
"path": "ImagingStudy.series.instance.type",
"short": "Type of instance (image etc) (0004,1430)",
"definition": "A human-friendly SOP Class name.",
"comments": "E.g., 'CT image', 'MR multi-frame', 'blending presentation'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0004,1430"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImagingStudy.series.instance.title",
"short": "Description (0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008)",
"definition": "The description of the instance.",
"comments": "Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "dicom",
"map": "0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImagingStudy.series.instance.content",
"short": "Content of the instance",
"definition": "Content of the instance or a rendering thereof (e.g., a JPEG of an image, or an XML of a structured report). May be represented by inline encoding, or by a URL reference to a WADO-RS service that makes the instance available. Multiple content attachments may be used for alternate representations of the instance.",
"comments": "Each instance may have a url and an attachment. Both represent the same information, but using different approaches. The attachment is a reference to a FHIR resource (Media, Document, etc).",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text.binary"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Immunization",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Immunization",
"name": "Immunization",
"publisher": "HL7 FHIR Project (Public Health and Emergency Response)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pher/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Immunization Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Immunization",
"short": "Immunization event information",
"definition": "Immunization event information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Immunization"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "Immunization.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Immunization.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Immunization.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Immunization.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Immunization.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Immunization.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this immunization record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Immunization.date",
"short": "Vaccination administration date",
"definition": "Date vaccine administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "v2",
"map": "RXA-3-date/time start of administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Immunization.vaccineType",
"short": "Vaccine product administered",
"definition": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccineType",
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccinetype"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Immunization.patient",
"short": "Who was immunized?",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
}
]
},
{
"path": "Immunization.wasNotGiven",
"short": "Was immunization given?",
"definition": "Indicates if the vaccination was or was not given.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"constraint": [
{
"key": "imm-2",
"name": "Given administration",
"severity": "error",
"human": "If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))"
},
{
"key": "imm-1",
"name": "Not given administration",
"severity": "error",
"human": "If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:wasNotGiven/@value='true' and (count(f:reaction) > 0 or exists(f:explanation/reason)))"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
},
{
"path": "Immunization.reported",
"short": "Is this a self-reported record?",
"definition": "True if this administration was reported rather than directly administered.",
"comments": "May need source of reported info (e.g. parent), but leave out for now.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.performer",
"short": "Who administered vaccine?",
"definition": "Clinician who administered the vaccine.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity": "v2",
"map": "RXA-10-administering provider"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.requester",
"short": "Who ordered vaccination?",
"definition": "Clinician who ordered the vaccination.",
"comments": "Other participants - delegate to Provenance resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12-ordering provider"
},
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
}
]
},
{
"path": "Immunization.manufacturer",
"short": "Vaccine manufacturer",
"definition": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
},
{
"identity": "v2",
"map": "RXA-17-substance manufacturer name"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
}
]
},
{
"path": "Immunization.location",
"short": "Where did vaccination occur?",
"definition": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
}
]
},
{
"path": "Immunization.lotNumber",
"short": "Vaccine lot number",
"definition": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
},
{
"identity": "v2",
"map": "RXA-15-substance lot number"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
}
]
},
{
"path": "Immunization.expirationDate",
"short": "Vaccine expiration date",
"definition": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-16-substance expiration date"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
"path": "Immunization.site",
"short": "Body site vaccine was administered",
"definition": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationSite",
"strength": "example",
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-site"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
"identity": "v2",
"map": "RXR-2-administration site"
},
{
"identity": "rim",
"map": "observation.targetSiteCode"
}
]
},
{
"path": "Immunization.route",
"short": "How vaccine entered body",
"definition": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRoute",
"strength": "example",
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-route"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
},
{
"identity": "v2",
"map": "RXR-1-route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "Immunization.doseQuantity",
"short": "Amount of vaccine administered",
"definition": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-administered amount / RXA-7.1-administered units.code"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "Immunization.explanation",
"short": "Administration / non-administration reasons",
"definition": "Reasons why a vaccine was or was not administered.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.explanation.reason",
"short": "Why immunization occurred",
"definition": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
}
]
},
{
"path": "Immunization.explanation.reasonNotGiven",
"short": "Why immunization did not occur",
"definition": "Reason why a vaccine was not administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NoImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/no-immunization-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-18"
},
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
},
{
"path": "Immunization.reaction",
"short": "Details of a reaction that follows immunization",
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
}
]
},
{
"path": "Immunization.reaction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.reaction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.reaction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.reaction.date",
"short": "When did reaction start?",
"definition": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the V2.x VXU message - most likely would appear in OBX segments if at all\n)"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Immunization.reaction.detail",
"short": "Additional information on reaction",
"definition": "Details of the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Immunization.reaction.reported",
"short": "Was reaction self-reported?",
"definition": "Self-reported indicator.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in V2.x)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.vaccinationProtocol",
"short": "What protocol was followed",
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "(V2.x doesn't seem to provide for this)"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"path": "Immunization.vaccinationProtocol.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.vaccinationProtocol.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.vaccinationProtocol.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseSequence",
"short": "What dose number within series?",
"definition": "Nominal position in a series.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
},
{
"path": "Immunization.vaccinationProtocol.description",
"short": "Details of vaccine protocol",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
},
{
"path": "Immunization.vaccinationProtocol.series",
"short": "Name of vaccine series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"path": "Immunization.vaccinationProtocol.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseTarget",
"short": "Disease immunized against",
"definition": "The targeted disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseTarget",
"strength": "example",
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-target"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseStatus",
"short": "Does dose count towards immunity?",
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"comments": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatus",
"strength": "example",
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"short": "Why does does count/not count?",
"definition": "Provides an explanation as to why a immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatusReason",
"strength": "example",
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Immunization",
"short": "Immunization event information",
"definition": "Immunization event information.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "Immunization.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this immunization record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Immunization.date",
"short": "Vaccination administration date",
"definition": "Date vaccine administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "v2",
"map": "RXA-3-date/time start of administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Immunization.vaccineType",
"short": "Vaccine product administered",
"definition": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccineType",
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccinetype"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Immunization.patient",
"short": "Who was immunized?",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
}
]
},
{
"path": "Immunization.wasNotGiven",
"short": "Was immunization given?",
"definition": "Indicates if the vaccination was or was not given.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"constraint": [
{
"key": "imm-2",
"name": "Given administration",
"severity": "error",
"human": "If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:wasNotGiven/@value='false' and exists(f:explanation/f:reasonNotGiven))"
},
{
"key": "imm-1",
"name": "Not given administration",
"severity": "error",
"human": "If immunization was not administred (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:wasNotGiven/@value='true' and (count(f:reaction) > 0 or exists(f:explanation/reason)))"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
},
{
"path": "Immunization.reported",
"short": "Is this a self-reported record?",
"definition": "True if this administration was reported rather than directly administered.",
"comments": "May need source of reported info (e.g. parent), but leave out for now.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.performer",
"short": "Who administered vaccine?",
"definition": "Clinician who administered the vaccine.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity": "v2",
"map": "RXA-10-administering provider"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.requester",
"short": "Who ordered vaccination?",
"definition": "Clinician who ordered the vaccination.",
"comments": "Other participants - delegate to Provenance resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12-ordering provider"
},
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
}
]
},
{
"path": "Immunization.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
}
]
},
{
"path": "Immunization.manufacturer",
"short": "Vaccine manufacturer",
"definition": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
},
{
"identity": "v2",
"map": "RXA-17-substance manufacturer name"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
}
]
},
{
"path": "Immunization.location",
"short": "Where did vaccination occur?",
"definition": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
}
]
},
{
"path": "Immunization.lotNumber",
"short": "Vaccine lot number",
"definition": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
},
{
"identity": "v2",
"map": "RXA-15-substance lot number"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
}
]
},
{
"path": "Immunization.expirationDate",
"short": "Vaccine expiration date",
"definition": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-16-substance expiration date"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
"path": "Immunization.site",
"short": "Body site vaccine was administered",
"definition": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationSite",
"strength": "example",
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-site"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
},
{
"identity": "v2",
"map": "RXR-2-administration site"
},
{
"identity": "rim",
"map": "observation.targetSiteCode"
}
]
},
{
"path": "Immunization.route",
"short": "How vaccine entered body",
"definition": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRoute",
"strength": "example",
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-route"
}
},
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
},
{
"identity": "v2",
"map": "RXR-1-route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "Immunization.doseQuantity",
"short": "Amount of vaccine administered",
"definition": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-administered amount / RXA-7.1-administered units.code"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "Immunization.explanation",
"short": "Administration / non-administration reasons",
"definition": "Reasons why a vaccine was or was not administered.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Immunization.explanation.reason",
"short": "Why immunization occurred",
"definition": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
}
]
},
{
"path": "Immunization.explanation.reasonNotGiven",
"short": "Why immunization did not occur",
"definition": "Reason why a vaccine was not administered.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NoImmunizationReason",
"strength": "example",
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/no-immunization-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-18"
},
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
},
{
"path": "Immunization.reaction",
"short": "Details of a reaction that follows immunization",
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
}
]
},
{
"path": "Immunization.reaction.date",
"short": "When did reaction start?",
"definition": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the V2.x VXU message - most likely would appear in OBX segments if at all\n)"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Immunization.reaction.detail",
"short": "Additional information on reaction",
"definition": "Details of the reaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "Immunization.reaction.reported",
"short": "Was reaction self-reported?",
"definition": "Self-reported indicator.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in V2.x)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"path": "Immunization.vaccinationProtocol",
"short": "What protocol was followed",
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "(V2.x doesn't seem to provide for this)"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseSequence",
"short": "What dose number within series?",
"definition": "Nominal position in a series.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
},
{
"path": "Immunization.vaccinationProtocol.description",
"short": "Details of vaccine protocol",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
},
{
"path": "Immunization.vaccinationProtocol.series",
"short": "Name of vaccine series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"path": "Immunization.vaccinationProtocol.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseTarget",
"short": "Disease immunized against",
"definition": "The targeted disease.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseTarget",
"strength": "example",
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-target"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseStatus",
"short": "Does dose count towards immunity?",
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"comments": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatus",
"strength": "example",
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value"
}
]
},
{
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"short": "Why does does count/not count?",
"definition": "Provides an explanation as to why a immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccinationProtocolDoseStatusReason",
"strength": "example",
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ImmunizationRecommendation",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
"name": "ImmunizationRecommendation",
"publisher": "HL7 FHIR Project (Public Health and Emergency Response)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pher/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ImmunizationRecommendation Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"min": 1,
"max": "1",
"type": [
{
"code": "ImmunizationRecommendation"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
}
]
},
{
"path": "ImmunizationRecommendation.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ImmunizationRecommendation.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ImmunizationRecommendation.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ImmunizationRecommendation.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ImmunizationRecommendation.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ImmunizationRecommendation.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient for whom the recommendations are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"short": "Date recommendation created",
"definition": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-15-date/time of the observation"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineType",
"short": "Vaccine recommendation applies to",
"definition": "Vaccine that pertains to the recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccineType",
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccinetype"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number",
"definition": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine administration status",
"definition": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRecommendationStatus",
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59783-1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"short": "Dates governing proposed immunization",
"definition": "Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"short": "Type of date",
"definition": "Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRecommendationDateCriterion",
"strength": "example",
"description": "Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3-observation identifier"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"short": "Recommended date",
"definition": "Date recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"short": "Protocol used by recommendation",
"definition": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"short": "Number of dose within sequence",
"definition": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.description",
"short": "Protocol details",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30956-7"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.series",
"short": "Name of vaccination series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
}
],
"mapping": [
{
"identity": "v2",
"map": "? No clear way to associate in V2.x or IG"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"short": "Patient observations supporting recommendation",
"definition": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX' ), could contain the reason the vaccine was not administered"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ImmunizationRecommendation",
"short": "Guidance or advice relating to an immunization",
"definition": "A patient's point-of-time immunization status and recommendation with optional supporting justification.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration[moodCode=RMD]"
}
]
},
{
"path": "ImmunizationRecommendation.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this particular recommendation record.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "ImmunizationRecommendation.patient",
"short": "Who this profile is for",
"definition": "The patient for whom the recommendations are for.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".partipication[typeCode=SUBJ].role"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation",
"short": "Vaccine administration recommendations",
"definition": "Vaccine administration recommendations.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.date",
"short": "Date recommendation created",
"definition": "The date the immunization recommendation was created.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-15-date/time of the observation"
},
{
"identity": "rim",
"map": ".partipication[typeCode=AUTH].time"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.vaccineType",
"short": "Vaccine recommendation applies to",
"definition": "Vaccine that pertains to the recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "VaccineType",
"strength": "example",
"description": "The type of vaccine administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vaccinetype"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"
},
{
"identity": "rim",
"map": ".partipication[typeCode=CSM].role[classCode=ADMM].code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.doseNumber",
"short": "Recommended dose number",
"definition": "This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose).",
"comments": "May need other dose concepts such as administered vs. valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.forecastStatus",
"short": "Vaccine administration status",
"definition": "Vaccine administration status.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRecommendationStatus",
"strength": "example",
"description": "The patient's status with respect to a vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59783-1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code=\"Immunization Forecast Status\"].value"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion",
"short": "Dates governing proposed immunization",
"definition": "Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.code",
"short": "Type of date",
"definition": "Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ImmunizationRecommendationDateCriterion",
"strength": "example",
"description": "Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/immunization-recommendation-date-criterion"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3-observation identifier"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
"short": "Recommended date",
"definition": "Date recommendation.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol",
"short": "Protocol used by recommendation",
"definition": "Contains information about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=INST].source[classCode=SBADM, moodCode=DEF]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
"short": "Number of dose within sequence",
"definition": "Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30973-2"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.description",
"short": "Protocol details",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 30956-7"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol? E.g. ACIP.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5-observation value : OBX-3-observation identifier = 59779-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.protocol.series",
"short": "Name of vaccination series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-administered code"
},
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingImmunization",
"short": "Past immunizations supporting recommendation",
"definition": "Immunization event history that supports the status and recommendation.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
}
],
"mapping": [
{
"identity": "v2",
"map": "? No clear way to associate in V2.x or IG"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code=\"immunization\"]"
}
]
},
{
"path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
"short": "Patient observations supporting recommendation",
"definition": "Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX' ), could contain the reason the vaccine was not administered"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "List",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/List",
"name": "List",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for List Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "List",
"short": "Information summarized from a list of other resources",
"definition": "A set of information summarized from a list of other resources.",
"alias": [
"Collection",
"WorkingList",
"Organizer"
],
"min": 1,
"max": "1",
"type": [
{
"code": "List"
}
],
"constraint": [
{
"key": "lst-2",
"name": "Deleted Rule",
"severity": "error",
"human": "The deleted flag can only be used if the mode of the list is \"changes\"",
"xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"
},
{
"key": "lst-1",
"name": "No emptyReason if list is not empty",
"severity": "error",
"human": "A list can only have an emptyReason if it is empty",
"xpath": "not(exists(f:emptyReason) and exists(f:entry))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode<ORG,moodCode=EVN]"
}
]
},
{
"path": "List.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "List.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "List.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "List.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "List.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "List.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "List.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "List.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "List.identifier",
"short": "Business identifier",
"definition": "Identifier for the List assigned for business purposes outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "List.code",
"short": "What the purpose of this list is",
"definition": "This code defines the purpose of the list - why it was created.",
"comments": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.",
"requirements": "Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListPurpose",
"strength": "example",
"description": "What the purpose of a list is",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-example-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "List.subject",
"short": "If all resources have the same subject",
"definition": "The common subject (or patient) of the resources that are in the list, if there is one.",
"comments": "Some purely aribitrary lists do not have a common subject, so this is optional.",
"requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<SUB].role\n(and sometimes .player)"
}
]
},
{
"path": "List.source",
"short": "Who and/or what defined the list contents",
"definition": "The entity responsible for deciding what the contents of the list were.",
"comments": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.",
"requirements": "Allows follow-up as well as context.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST]\nor\n.participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]"
}
]
},
{
"path": "List.date",
"short": "When the list was prepared",
"definition": "The date that the list was prepared.",
"comments": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.",
"requirements": "Identifies how current the list is which affects relevance.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].time[type=TS]"
}
]
},
{
"path": "List.orderedBy",
"short": "What order the list has",
"definition": "What order applies to the items in the list.",
"comments": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.",
"requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListOrder",
"strength": "preferred",
"description": "What order applies to the items in a list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-order"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
}
]
},
{
"path": "List.mode",
"short": "working | snapshot | changes",
"definition": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ListMode",
"strength": "required",
"description": "The processing mode that applies to this list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
},
{
"path": "List.entry",
"short": "Entries in the list",
"definition": "Entries in this list.",
"comments": "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min": 0,
"max": "*",
"condition": [
"lst-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]\nor \n.participation[typeCode=SBJ]"
}
]
},
{
"path": "List.entry.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "List.entry.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "List.entry.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "List.entry.flag",
"short": "Workflow information about this item",
"definition": "The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.",
"comments": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".",
"requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListItemFlag",
"strength": "example",
"description": "Codes that provide further information about the reason and meaning of the item in the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-item-flag"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
},
{
"path": "List.entry.deleted",
"short": "If this item is actually marked as deleted",
"definition": "True if this item is marked as deleted in the list.",
"comments": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.",
"requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"lst-2"
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "added: .updateMode=(\"A\",\"AR\")\n\nretained: .updateMode=\"NC\"\n\nupdated: .updateMode=\"R\"\n\ndeleted: .updateMode=\"D\""
}
]
},
{
"path": "List.entry.date",
"short": "When item added to list",
"definition": "When this item was added to the list.",
"comments": "This is only useful and meaningful when the mode is \"working\".",
"requirements": "The date may be significant for understanding the meaning of items in a working list.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime"
}
]
},
{
"path": "List.entry.item",
"short": "Actual entry",
"definition": "A reference to the actual resource from which data was derived.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".target\nor\n.role\nor\n.role.entity"
}
]
},
{
"path": "List.emptyReason",
"short": "Why list is empty",
"definition": "If the list is empty, why the list is empty.",
"comments": "The various reasons for an empty list make a significant interpretation to its interpretation.",
"requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"lst-1"
],
"binding": {
"name": "ListEmptyReason",
"strength": "preferred",
"description": "If a list is empty, why it is empty",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-empty-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "List",
"short": "Information summarized from a list of other resources",
"definition": "A set of information summarized from a list of other resources.",
"alias": [
"Collection",
"WorkingList",
"Organizer"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "lst-2",
"name": "Deleted Rule",
"severity": "error",
"human": "The deleted flag can only be used if the mode of the list is \"changes\"",
"xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"
},
{
"key": "lst-1",
"name": "No emptyReason if list is not empty",
"severity": "error",
"human": "A list can only have an emptyReason if it is empty",
"xpath": "not(exists(f:emptyReason) and exists(f:entry))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode<ORG,moodCode=EVN]"
}
]
},
{
"path": "List.identifier",
"short": "Business identifier",
"definition": "Identifier for the List assigned for business purposes outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "List.code",
"short": "What the purpose of this list is",
"definition": "This code defines the purpose of the list - why it was created.",
"comments": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.",
"requirements": "Lists often contain subsets of resources rather than an exhaustive list. The code identifies what type of subset is included.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListPurpose",
"strength": "example",
"description": "What the purpose of a list is",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-example-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "List.subject",
"short": "If all resources have the same subject",
"definition": "The common subject (or patient) of the resources that are in the list, if there is one.",
"comments": "Some purely aribitrary lists do not have a common subject, so this is optional.",
"requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<SUB].role\n(and sometimes .player)"
}
]
},
{
"path": "List.source",
"short": "Who and/or what defined the list contents",
"definition": "The entity responsible for deciding what the contents of the list were.",
"comments": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.",
"requirements": "Allows follow-up as well as context.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST]\nor\n.participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]"
}
]
},
{
"path": "List.date",
"short": "When the list was prepared",
"definition": "The date that the list was prepared.",
"comments": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.",
"requirements": "Identifies how current the list is which affects relevance.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].time[type=TS]"
}
]
},
{
"path": "List.orderedBy",
"short": "What order the list has",
"definition": "What order applies to the items in the list.",
"comments": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.",
"requirements": "Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListOrder",
"strength": "preferred",
"description": "What order applies to the items in a list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-order"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
}
]
},
{
"path": "List.mode",
"short": "working | snapshot | changes",
"definition": "How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.",
"requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ListMode",
"strength": "required",
"description": "The processing mode that applies to this list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
},
{
"path": "List.entry",
"short": "Entries in the list",
"definition": "Entries in this list.",
"comments": "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min": 0,
"max": "*",
"condition": [
"lst-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]\nor \n.participation[typeCode=SBJ]"
}
]
},
{
"path": "List.entry.flag",
"short": "Workflow information about this item",
"definition": "The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.",
"comments": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".",
"requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ListItemFlag",
"strength": "example",
"description": "Codes that provide further information about the reason and meaning of the item in the list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-item-flag"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
},
{
"path": "List.entry.deleted",
"short": "If this item is actually marked as deleted",
"definition": "True if this item is marked as deleted in the list.",
"comments": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.",
"requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"condition": [
"lst-2"
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "added: .updateMode=(\"A\",\"AR\")\n\nretained: .updateMode=\"NC\"\n\nupdated: .updateMode=\"R\"\n\ndeleted: .updateMode=\"D\""
}
]
},
{
"path": "List.entry.date",
"short": "When item added to list",
"definition": "When this item was added to the list.",
"comments": "This is only useful and meaningful when the mode is \"working\".",
"requirements": "The date may be significant for understanding the meaning of items in a working list.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime"
}
]
},
{
"path": "List.entry.item",
"short": "Actual entry",
"definition": "A reference to the actual resource from which data was derived.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".target\nor\n.role\nor\n.role.entity"
}
]
},
{
"path": "List.emptyReason",
"short": "Why list is empty",
"definition": "If the list is empty, why the list is empty.",
"comments": "The various reasons for an empty list make a significant interpretation to its interpretation.",
"requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"lst-1"
],
"binding": {
"name": "ListEmptyReason",
"strength": "preferred",
"description": "If a list is empty, why it is empty",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/list-empty-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Location",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Location",
"name": "Location",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Location Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Location",
"short": "Details and position information for a physical place",
"definition": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".Role[classCode=SDLC]"
}
]
},
{
"path": "Location.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Location.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Location.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Location.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Location.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Location.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Location.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Location.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Location.identifier",
"short": "Unique code or number identifying the location to its users",
"definition": "Unique code or number identifying the location to its users.",
"requirements": "Organization label locations in registries, need to keep track of those.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Location.name",
"short": "Name of the location as used by humans",
"definition": "Name of the location as used by humans. Does not need to be unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Location.description",
"short": "Description of the Location, which helps in finding or referencing the place",
"definition": "Description of the Location, which helps in finding or referencing the place.",
"requirements": "Humans need additional information to verify a correct location has been identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
},
{
"path": "Location.mode",
"short": "instance | kind",
"definition": "Indicates whether a resource instance represents a specific location or a class of locations.",
"requirements": "When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "LocationMode",
"strength": "required",
"description": "Indicates whether a resource instance represents a specific location or a class of locations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC].determinerCode"
}
]
},
{
"path": "Location.type",
"short": "Indicates the type of function performed at the location",
"definition": "Indicates the type of function performed at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "LocationType",
"strength": "required",
"description": "Indicates the type of function performed at the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Location.telecom",
"short": "Contact details of the location",
"definition": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
},
{
"path": "Location.address",
"short": "Physical location",
"definition": "Physical location.",
"comments": "This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.",
"requirements": "If locations can be visited, we need to keep track of their address.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "rim",
"map": ".addr"
}
]
},
{
"path": "Location.physicalType",
"short": "Physical form of the location",
"definition": "Physical form of the location, e.g. building, room, vehicle, road.",
"requirements": "For purposes of showing relevant locations in queries, we need to categorize locations.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PhysicalType",
"strength": "example",
"description": "Physical form of the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-physical-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC].code"
}
]
},
{
"path": "Location.position",
"short": "The absolute geographic location",
"definition": "The absolute geographic location of the Location, expressed in with the WGS84 datum (This is the same co-ordinate system used in KML).",
"requirements": "For mobile applications and automated route-finding knowing the exact location of the Location is required.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
},
{
"path": "Location.position.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Location.position.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Location.position.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Location.position.longitude",
"short": "Longitude with WGS84 datum",
"definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.position.latitude",
"short": "Latitude with WGS84 datum",
"definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.position.altitude",
"short": "Altitude with WGS84 datum",
"definition": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.managingOrganization",
"short": "The organization that is responsible for the provisioning and upkeep of the location",
"definition": "The organization that is responsible for the provisioning and upkeep of the location.",
"comments": "This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.",
"requirements": "Need to know who manages the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
},
{
"path": "Location.partOf",
"short": "Another Location which this Location is physically part of",
"definition": "Another Location which this Location is physically part of.",
"requirements": "For purposes of location, display and identification, knowing which locations are located within other locations is important.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
},
{
"path": "Location.status",
"short": "active | suspended | inactive",
"definition": "active | suspended | inactive.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "LocationStatus",
"strength": "required",
"description": "Indicates whether the location is still in use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Location",
"short": "Details and position information for a physical place",
"definition": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".Role[classCode=SDLC]"
}
]
},
{
"path": "Location.identifier",
"short": "Unique code or number identifying the location to its users",
"definition": "Unique code or number identifying the location to its users.",
"requirements": "Organization label locations in registries, need to keep track of those.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Location.name",
"short": "Name of the location as used by humans",
"definition": "Name of the location as used by humans. Does not need to be unique.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Location.description",
"short": "Description of the Location, which helps in finding or referencing the place",
"definition": "Description of the Location, which helps in finding or referencing the place.",
"requirements": "Humans need additional information to verify a correct location has been identified.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC determinerCode=INSTANCE].desc"
}
]
},
{
"path": "Location.mode",
"short": "instance | kind",
"definition": "Indicates whether a resource instance represents a specific location or a class of locations.",
"requirements": "When using a Location resource for scheduling or orders, we need to be able to refer to a class of Locations instead of a specific Location.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "LocationMode",
"strength": "required",
"description": "Indicates whether a resource instance represents a specific location or a class of locations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".playingEntity[classCode=PLC].determinerCode"
}
]
},
{
"path": "Location.type",
"short": "Indicates the type of function performed at the location",
"definition": "Indicates the type of function performed at the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "LocationType",
"strength": "required",
"description": "Indicates the type of function performed at the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ServiceDeliveryLocationRoleType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Location.telecom",
"short": "Contact details of the location",
"definition": "The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "rim",
"map": ".telecom"
}
]
},
{
"path": "Location.address",
"short": "Physical location",
"definition": "Physical location.",
"comments": "This was kept as 0..1 as there is no use property on the address, so wouldn't be able to identify different address types.",
"requirements": "If locations can be visited, we need to keep track of their address.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "rim",
"map": ".addr"
}
]
},
{
"path": "Location.physicalType",
"short": "Physical form of the location",
"definition": "Physical form of the location, e.g. building, room, vehicle, road.",
"requirements": "For purposes of showing relevant locations in queries, we need to categorize locations.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PhysicalType",
"strength": "example",
"description": "Physical form of the location",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-physical-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC].code"
}
]
},
{
"path": "Location.position",
"short": "The absolute geographic location",
"definition": "The absolute geographic location of the Location, expressed in with the WGS84 datum (This is the same co-ordinate system used in KML).",
"requirements": "For mobile applications and automated route-finding knowing the exact location of the Location is required.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".playingEntity [classCode=PLC determinerCode=INSTANCE].positionText"
}
]
},
{
"path": "Location.position.longitude",
"short": "Longitude with WGS84 datum",
"definition": "Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.position.latitude",
"short": "Latitude with WGS84 datum",
"definition": "Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).",
"min": 1,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.position.altitude",
"short": "Altitude with WGS84 datum",
"definition": "Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": "(RIM Opted not to map the sub-elements of GPS location, is now an OBS)"
}
]
},
{
"path": "Location.managingOrganization",
"short": "The organization that is responsible for the provisioning and upkeep of the location",
"definition": "The organization that is responsible for the provisioning and upkeep of the location.",
"comments": "This can also be used as the part of the organization hierarchy where this location provides services. These services can be defined through the HealthcareService resource.",
"requirements": "Need to know who manages the location.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scopingEntity[classCode=ORG determinerKind=INSTANCE]"
}
]
},
{
"path": "Location.partOf",
"short": "Another Location which this Location is physically part of",
"definition": "Another Location which this Location is physically part of.",
"requirements": "For purposes of location, display and identification, knowing which locations are located within other locations is important.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundLink[typeCode=PART].source[classCode=SDLC]"
}
]
},
{
"path": "Location.status",
"short": "active | suspended | inactive",
"definition": "active | suspended | inactive.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "LocationStatus",
"strength": "required",
"description": "Indicates whether the location is still in use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/location-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Media",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Media",
"name": "Media",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Media Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Media",
"short": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference",
"definition": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "Media"
}
],
"constraint": [
{
"key": "mda-1",
"name": "Height rule",
"severity": "error",
"human": "Height can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:height)"
},
{
"key": "mda-2",
"name": "Width rule",
"severity": "error",
"human": "Width can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:width)"
},
{
"key": "mda-4",
"name": "Length rule",
"severity": "error",
"human": "Length can only be used for an audio or a video",
"xpath": "not(f:type/@value='photo') or not(f:length)"
},
{
"key": "mda-3",
"name": "Frames rule",
"severity": "error",
"human": "Frames can only be used for a photo",
"xpath": "(f:type/@value='photo') or not(f:frames)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]"
}
]
},
{
"path": "Media.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Media.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Media.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Media.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Media.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Media.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Media.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Media.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Media.type",
"short": "photo | video | audio",
"definition": "Whether the media is a photo (still image), an audio recording, or a video recording.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DigitalMediaType",
"strength": "required",
"description": "Whether the Media is a photo, video, or audio",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/digital-media-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Media.subtype",
"short": "The type of acquisition equipment/process",
"definition": "Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DigitalMediaSubtype",
"strength": "example",
"description": "Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/digital-media-subtype"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060 | 0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Media.identifier",
"short": "Identifier(s) for the image",
"definition": "Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.",
"comments": "The identifier label and use can be used to determine what kind of identifier it is.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Media.subject",
"short": "Who/What this Media is a record of",
"definition": "Who/What this Media is a record of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "~0010,0020"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SUBJ\"]???"
}
]
},
{
"path": "Media.operator",
"short": "The person who generated the image",
"definition": "The person who administered the collection of the image.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,1060?"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"PERF\"]???"
}
]
},
{
"path": "Media.view",
"short": "Imaging view e.g Lateral or Antero-posterior",
"definition": "The name of the imaging view e.g Lateral or Antero-posterior (AP).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MediaView",
"strength": "example",
"description": "Imaging view (projection) used when collecting an image",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/media-view"
}
},
"mapping": [
{
"identity": "rim",
"map": "DiagnosticImage.subjectOrientationCode"
}
]
},
{
"path": "Media.deviceName",
"short": "Name of the device/manufacturer",
"definition": "The name of the device / manufacturer of the device that was used to make the recording.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,0070"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name"
}
]
},
{
"path": "Media.height",
"short": "Height of the image in pixels(photo/video)",
"definition": "Height of the image in pixels(photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-1"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0028,0010"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.width",
"short": "Width of the image in pixels (photo/video)",
"definition": "Width of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-2"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0028,0011"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.frames",
"short": "Number of frames if > 1 (photo)",
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-3"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.duration",
"short": "Length in seconds (audio / video)",
"definition": "The duration of the recording in seconds - for audio and video.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-4"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "~0028,0002"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.content",
"short": "Actual Media - reference or data",
"definition": "The actual content of the media - inline or by direct reference to the media source file.",
"comments": "Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter.\n\nFor an media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Media",
"short": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference",
"definition": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "mda-1",
"name": "Height rule",
"severity": "error",
"human": "Height can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:height)"
},
{
"key": "mda-2",
"name": "Width rule",
"severity": "error",
"human": "Width can only be used for a photo or video",
"xpath": "not(f:type/@value='audio') or not(f:width)"
},
{
"key": "mda-4",
"name": "Length rule",
"severity": "error",
"human": "Length can only be used for an audio or a video",
"xpath": "not(f:type/@value='photo') or not(f:length)"
},
{
"key": "mda-3",
"name": "Frames rule",
"severity": "error",
"human": "Frames can only be used for a photo",
"xpath": "(f:type/@value='photo') or not(f:frames)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=\"DGIMG\", moodCode=\"EVN\"]"
}
]
},
{
"path": "Media.type",
"short": "photo | video | audio",
"definition": "Whether the media is a photo (still image), an audio recording, or a video recording.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "DigitalMediaType",
"strength": "required",
"description": "Whether the Media is a photo, video, or audio",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/digital-media-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Media.subtype",
"short": "The type of acquisition equipment/process",
"definition": "Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "DigitalMediaSubtype",
"strength": "example",
"description": "Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/digital-media-subtype"
}
},
"mapping": [
{
"identity": "dicom",
"map": "0008,0060 | 0008,1032"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Media.identifier",
"short": "Identifier(s) for the image",
"definition": "Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.",
"comments": "The identifier label and use can be used to determine what kind of identifier it is.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Media.subject",
"short": "Who/What this Media is a record of",
"definition": "Who/What this Media is a record of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "~0010,0020"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"SUBJ\"]???"
}
]
},
{
"path": "Media.operator",
"short": "The person who generated the image",
"definition": "The person who administered the collection of the image.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,1060?"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"PERF\"]???"
}
]
},
{
"path": "Media.view",
"short": "Imaging view e.g Lateral or Antero-posterior",
"definition": "The name of the imaging view e.g Lateral or Antero-posterior (AP).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MediaView",
"strength": "example",
"description": "Imaging view (projection) used when collecting an image",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/media-view"
}
},
"mapping": [
{
"identity": "rim",
"map": "DiagnosticImage.subjectOrientationCode"
}
]
},
{
"path": "Media.deviceName",
"short": "Name of the device/manufacturer",
"definition": "The name of the device / manufacturer of the device that was used to make the recording.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0008,0070"
},
{
"identity": "rim",
"map": ".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name"
}
]
},
{
"path": "Media.height",
"short": "Height of the image in pixels(photo/video)",
"definition": "Height of the image in pixels(photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-1"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0028,0010"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.width",
"short": "Width of the image in pixels (photo/video)",
"definition": "Width of the image in pixels (photo/video).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-2"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "0028,0011"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.frames",
"short": "Number of frames if > 1 (photo)",
"definition": "The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-3"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.duration",
"short": "Length in seconds (audio / video)",
"definition": "The duration of the recording in seconds - for audio and video.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"condition": [
"mda-4"
],
"isSummary": true,
"mapping": [
{
"identity": "dicom",
"map": "~0028,0002"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"OBS\", moodCode=\"EVN\",code=\"<CODE>\"].value"
}
]
},
{
"path": "Media.content",
"short": "Actual Media - reference or data",
"definition": "The actual content of the media - inline or by direct reference to the media source file.",
"comments": "Recommended content types: image/jpeg, image/png, image/tiff, video/mpeg, audio/mp4, application/dicom. Application/dicom can contain the transfer syntax as a parameter.\n\nFor an media that covers a period of time (video/sound), the content.creationTime is the end time. Creation time is used for tracking, organizing versions and searching.",
"min": 1,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Medication",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Medication",
"name": "Medication",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Medication Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Medication",
"short": "Definition of a Medication",
"definition": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"min": 1,
"max": "1",
"type": [
{
"code": "Medication"
}
],
"mapping": [
{
"identity": "rim",
"map": "ManufacturedProduct[classCode=ADMM]"
}
]
},
{
"path": "Medication.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Medication.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Medication.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Medication.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Medication.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Medication.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.name",
"short": "Common / Commercial name",
"definition": "The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Medication.code",
"short": "Codes that identify this medication",
"definition": "A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.",
"comments": "When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MedicationFormalRepresentation",
"strength": "example",
"description": "A code that defines the type of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.isBrand",
"short": "True if a brand",
"definition": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true if .player.scopingRole[typeCode=MANU] exists"
}
]
},
{
"path": "Medication.manufacturer",
"short": "Manufacturer of the item",
"definition": "Describes the details of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity": "rim",
"map": ".player.scopingRole[typeCode=MANU].scoper"
}
]
},
{
"path": "Medication.kind",
"short": "product | package",
"definition": "Medications are either a single administrable product or a package that contains one or more products.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "MedicationKind",
"strength": "required",
"description": "Whether the medication is a product or a package",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.classCode\r(CONT or not)"
}
]
},
{
"path": "Medication.product",
"short": "Administrable medication details",
"definition": "Information that only applies to products (not packages).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player [classCode != CONT]"
}
]
},
{
"path": "Medication.product.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.form",
"short": "powder | tablets | carton +",
"definition": "Describes the form of the item. Powder; tables; carton.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationForm",
"strength": "example",
"description": "The form of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-form-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity": "rim",
"map": ".formCode"
}
]
},
{
"path": "Medication.product.ingredient",
"short": "Active or inactive ingredient",
"definition": "Identifies a particular constituent of interest in the product.",
"comments": "The ingredients need not be a complete list; usually only active ingredients are listed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=INGR]"
}
]
},
{
"path": "Medication.product.ingredient.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.ingredient.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.ingredient.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.ingredient.item",
"short": "The product contained",
"definition": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-2-Component Code\rif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.product.ingredient.amount",
"short": "How much ingredient in product",
"definition": "Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-3-Component Amount & RXC-4-Component Units\rif medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Medication.product.batch",
"short": "Information about a group of medication produced or packaged from one production run.",
"definition": "Information about a group of medication produced or packaged from one production run.",
"min": 0,
"max": "*"
},
{
"path": "Medication.product.batch.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.batch.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.batch.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.batch.lotNumber",
"short": "The assigned lot number of a batch of the specified product.",
"definition": "The assigned lot number of a batch of the specified product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Medication.product.batch.expirationDate",
"short": "When this specific batch of product will expire.",
"definition": "When this specific batch of product will expire.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Medication.package",
"short": "Details about packaged medications",
"definition": "Information that only applies to packages (not products).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player[classCode=CONT]"
}
]
},
{
"path": "Medication.package.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.package.container",
"short": "E.g. box, vial, blister-pack",
"definition": "The kind of container that this package comes as.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationContainer",
"strength": "example",
"description": "Kind of container a medication package is packaged in",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-package-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.package.content",
"short": "What is in the package?",
"definition": "A set of components that go to make up the described item.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=CONT]"
}
]
},
{
"path": "Medication.package.content.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.content.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.content.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.package.content.item",
"short": "A product in the package",
"definition": "Identifies one of the items in the package.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.package.content.amount",
"short": "How many are in the package?",
"definition": "The amount of the product that is in the package.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Medication",
"short": "Definition of a Medication",
"definition": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ManufacturedProduct[classCode=ADMM]"
}
]
},
{
"path": "Medication.name",
"short": "Common / Commercial name",
"definition": "The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Medication.code",
"short": "Codes that identify this medication",
"definition": "A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.",
"comments": "When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MedicationFormalRepresentation",
"strength": "example",
"description": "A code that defines the type of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.isBrand",
"short": "True if a brand",
"definition": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true if .player.scopingRole[typeCode=MANU] exists"
}
]
},
{
"path": "Medication.manufacturer",
"short": "Manufacturer of the item",
"definition": "Describes the details of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity": "rim",
"map": ".player.scopingRole[typeCode=MANU].scoper"
}
]
},
{
"path": "Medication.kind",
"short": "product | package",
"definition": "Medications are either a single administrable product or a package that contains one or more products.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "MedicationKind",
"strength": "required",
"description": "Whether the medication is a product or a package",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.classCode\r(CONT or not)"
}
]
},
{
"path": "Medication.product",
"short": "Administrable medication details",
"definition": "Information that only applies to products (not packages).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player [classCode != CONT]"
}
]
},
{
"path": "Medication.product.form",
"short": "powder | tablets | carton +",
"definition": "Describes the form of the item. Powder; tables; carton.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationForm",
"strength": "example",
"description": "The form of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-form-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity": "rim",
"map": ".formCode"
}
]
},
{
"path": "Medication.product.ingredient",
"short": "Active or inactive ingredient",
"definition": "Identifies a particular constituent of interest in the product.",
"comments": "The ingredients need not be a complete list; usually only active ingredients are listed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=INGR]"
}
]
},
{
"path": "Medication.product.ingredient.item",
"short": "The product contained",
"definition": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-2-Component Code\rif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.product.ingredient.amount",
"short": "How much ingredient in product",
"definition": "Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-3-Component Amount & RXC-4-Component Units\rif medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Medication.product.batch",
"short": "Information about a group of medication produced or packaged from one production run.",
"definition": "Information about a group of medication produced or packaged from one production run.",
"min": 0,
"max": "*"
},
{
"path": "Medication.product.batch.lotNumber",
"short": "The assigned lot number of a batch of the specified product.",
"definition": "The assigned lot number of a batch of the specified product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Medication.product.batch.expirationDate",
"short": "When this specific batch of product will expire.",
"definition": "When this specific batch of product will expire.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Medication.package",
"short": "Details about packaged medications",
"definition": "Information that only applies to packages (not products).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player[classCode=CONT]"
}
]
},
{
"path": "Medication.package.container",
"short": "E.g. box, vial, blister-pack",
"definition": "The kind of container that this package comes as.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationContainer",
"strength": "example",
"description": "Kind of container a medication package is packaged in",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-package-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.package.content",
"short": "What is in the package?",
"definition": "A set of components that go to make up the described item.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=CONT]"
}
]
},
{
"path": "Medication.package.content.item",
"short": "A product in the package",
"definition": "Identifies one of the items in the package.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.package.content.amount",
"short": "How many are in the package?",
"definition": "The amount of the product that is in the package.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "MedicationAdministration",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"name": "MedicationAdministration",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MedicationAdministration Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "MedicationAdministration",
"short": "Administration of medication to a patient",
"definition": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\r\rRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min": 1,
"max": "1",
"type": [
{
"code": "MedicationAdministration"
}
],
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "MedicationAdministration.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "MedicationAdministration.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "MedicationAdministration.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "MedicationAdministration.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "MedicationAdministration.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "MedicationAdministration.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationAdministration.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationAdministration.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationAdministration.identifier",
"short": "External identifier",
"definition": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier? (V2 def'n of RXA-25 refers to the 'give' occurrence; appears not to discuss 'administer' cardinality which would seem to be 0..*)"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "MedicationAdministration.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MedicationAdministrationStatus",
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationAdministration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-admin-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status"
},
{
"identity": "rim",
"map": "statusCode"
}
]
},
{
"path": "MedicationAdministration.patient",
"short": "Who received medication?",
"definition": "The person or animal to whom the medication was given.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject->Patient"
}
]
},
{
"path": "MedicationAdministration.practitioner",
"short": "Who administered substance?",
"definition": "The individual who was responsible for giving the medication to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity": "rim",
"map": "performer->Role"
}
]
},
{
"path": "MedicationAdministration.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
}
]
},
{
"path": "MedicationAdministration.prescription",
"short": "Order administration performed against",
"definition": "The original request, instruction or authority to perform the administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
},
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
}
]
},
{
"path": "MedicationAdministration.wasNotGiven",
"short": "True if medication not administered",
"definition": "Set this to true if the record is saying that the medication was NOT administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"path": "MedicationAdministration.reasonNotGiven",
"short": "Reason administration not performed",
"definition": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-2"
],
"constraint": [
{
"key": "mad-2",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')"
}
],
"binding": {
"name": "MedicationAdministrationNegationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "Reason->Observation->Value"
}
]
},
{
"path": "MedicationAdministration.reasonGiven",
"short": "Reason administration performed",
"definition": "A code indicating why the medication was given.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-3"
],
"constraint": [
{
"key": "mad-3",
"name": "Given reason",
"severity": "error",
"human": "Reason given is only permitted if wasNotGiven is false",
"xpath": "not(exists(f:reasonGiven) and f:wasNotGiven/@value='true')"
}
],
"binding": {
"name": "MedicationAdministrationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-given-codes"
}
}
},
{
"path": "MedicationAdministration.effectiveTime[x]",
"short": "Start and end time of administration",
"definition": "An interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationAdministration.medication",
"short": "What was administered?",
"definition": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the administered medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": "Consumeable->AdministerableMedication"
}
]
},
{
"path": "MedicationAdministration.device",
"short": "Device used to administer",
"definition": "The device used in administering the medication to the patient. E.g. a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-10-Participation Device"
},
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
}
]
},
{
"path": "MedicationAdministration.note",
"short": "Information about the administration",
"definition": "Extra information about the medication administration that is not conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationAdministration.dosage",
"short": "Details of how medication was taken",
"definition": "Indicates how the medication is/was used by the patient.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "mad-1",
"name": "Dose",
"severity": "error",
"human": "SHALL have at least one of dosage.quantity and dosage.rate",
"xpath": "exists(f:quantity) or exists(f:rate)"
}
],
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
},
{
"path": "MedicationAdministration.dosage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationAdministration.dosage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationAdministration.dosage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationAdministration.dosage.text",
"short": "Dosage Instructions",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationAdministration.dosage.site",
"short": "Body site administered to",
"definition": "A coded specification of the anatomic site where the medication first entered the body. E.g. \"left arm\".",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": "approachSiteCode"
}
]
},
{
"path": "MedicationAdministration.dosage.route",
"short": "Path of substance into body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": "routeCode"
}
]
},
{
"path": "MedicationAdministration.dosage.method",
"short": "How drug was administered",
"definition": "A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "MedicationAdministration.dosage.quantity",
"short": "Amount administered in one dose",
"definition": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comments": "If the administration is not instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount administered over period of time of a single administration (as indicated by schedule).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"
},
{
"identity": "rim",
"map": "doseQuantity"
}
]
},
{
"path": "MedicationAdministration.dosage.rate",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.",
"comments": "If the rate changes over time, each change should be captured as a distinct \"dosage\" repetition. This element should *not* be used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": "rateQuantity"
}
]
}
]
},
"differential": {
"element": [
{
"path": "MedicationAdministration",
"short": "Administration of medication to a patient",
"definition": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\r\rRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "MedicationAdministration.identifier",
"short": "External identifier",
"definition": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier? (V2 def'n of RXA-25 refers to the 'give' occurrence; appears not to discuss 'administer' cardinality which would seem to be 0..*)"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "MedicationAdministration.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MedicationAdministrationStatus",
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationAdministration",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-admin-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status"
},
{
"identity": "rim",
"map": "statusCode"
}
]
},
{
"path": "MedicationAdministration.patient",
"short": "Who received medication?",
"definition": "The person or animal to whom the medication was given.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject->Patient"
}
]
},
{
"path": "MedicationAdministration.practitioner",
"short": "Who administered substance?",
"definition": "The individual who was responsible for giving the medication to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity": "rim",
"map": "performer->Role"
}
]
},
{
"path": "MedicationAdministration.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
}
]
},
{
"path": "MedicationAdministration.prescription",
"short": "Order administration performed against",
"definition": "The original request, instruction or authority to perform the administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
},
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
}
]
},
{
"path": "MedicationAdministration.wasNotGiven",
"short": "True if medication not administered",
"definition": "Set this to true if the record is saying that the medication was NOT administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"path": "MedicationAdministration.reasonNotGiven",
"short": "Reason administration not performed",
"definition": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-2"
],
"constraint": [
{
"key": "mad-2",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')"
}
],
"binding": {
"name": "MedicationAdministrationNegationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "Reason->Observation->Value"
}
]
},
{
"path": "MedicationAdministration.reasonGiven",
"short": "Reason administration performed",
"definition": "A code indicating why the medication was given.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-3"
],
"constraint": [
{
"key": "mad-3",
"name": "Given reason",
"severity": "error",
"human": "Reason given is only permitted if wasNotGiven is false",
"xpath": "not(exists(f:reasonGiven) and f:wasNotGiven/@value='true')"
}
],
"binding": {
"name": "MedicationAdministrationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-given-codes"
}
}
},
{
"path": "MedicationAdministration.effectiveTime[x]",
"short": "Start and end time of administration",
"definition": "An interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationAdministration.medication",
"short": "What was administered?",
"definition": "Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the administered medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": "Consumeable->AdministerableMedication"
}
]
},
{
"path": "MedicationAdministration.device",
"short": "Device used to administer",
"definition": "The device used in administering the medication to the patient. E.g. a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-10-Participation Device"
},
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
}
]
},
{
"path": "MedicationAdministration.note",
"short": "Information about the administration",
"definition": "Extra information about the medication administration that is not conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationAdministration.dosage",
"short": "Details of how medication was taken",
"definition": "Indicates how the medication is/was used by the patient.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "mad-1",
"name": "Dose",
"severity": "error",
"human": "SHALL have at least one of dosage.quantity and dosage.rate",
"xpath": "exists(f:quantity) or exists(f:rate)"
}
],
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
},
{
"path": "MedicationAdministration.dosage.text",
"short": "Dosage Instructions",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationAdministration.dosage.site",
"short": "Body site administered to",
"definition": "A coded specification of the anatomic site where the medication first entered the body. E.g. \"left arm\".",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": "approachSiteCode"
}
]
},
{
"path": "MedicationAdministration.dosage.route",
"short": "Path of substance into body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": "routeCode"
}
]
},
{
"path": "MedicationAdministration.dosage.method",
"short": "How drug was administered",
"definition": "A coded value indicating the method by which the medication was introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "MedicationAdministration.dosage.quantity",
"short": "Amount administered in one dose",
"definition": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comments": "If the administration is not instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount administered over period of time of a single administration (as indicated by schedule).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"
},
{
"identity": "rim",
"map": "doseQuantity"
}
]
},
{
"path": "MedicationAdministration.dosage.rate",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.",
"comments": "If the rate changes over time, each change should be captured as a distinct \"dosage\" repetition. This element should *not* be used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": "rateQuantity"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "MedicationDispense",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"name": "MedicationDispense",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MedicationDispense Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "MedicationDispense",
"short": "Dispensing a medication to a named patient",
"definition": "Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "MedicationDispense"
}
],
"constraint": [
{
"key": "mdd-1",
"name": "Timing",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
}
]
},
{
"path": "MedicationDispense.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "MedicationDispense.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "MedicationDispense.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "MedicationDispense.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "MedicationDispense.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "MedicationDispense.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationDispense.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationDispense.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationDispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "MedicationDispense.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"strength": "required",
"description": "A code specifying the state of the dispense event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "(Not clear whether or how V2 provides for a snapshot of dispense status)"
},
{
"identity": "rim",
"map": ".status"
}
]
},
{
"path": "MedicationDispense.patient",
"short": "Who the dispense is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "MedicationDispense.dispenser",
"short": "Practitioner responsible for dispensing medication",
"definition": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
},
{
"path": "MedicationDispense.authorizingPrescription",
"short": "Medication order that authorizes the dispense",
"definition": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
}
]
},
{
"path": "MedicationDispense.type",
"short": "Trial fill, partial fill, emergency fill, etc.",
"definition": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationDispenseType",
"strength": "example",
"description": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "MedicationDispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "MedicationDispense.daysSupply",
"short": "Days Supply",
"definition": "The amount of medication expressed as a timing amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "MedicationDispense.medication",
"short": "What medication was supplied",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "MedicationDispense.whenPrepared",
"short": "Dispense processing time",
"definition": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
}
]
},
{
"path": "MedicationDispense.whenHandedOver",
"short": "Handover time",
"definition": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
}
]
},
{
"path": "MedicationDispense.destination",
"short": "Where the medication was sent",
"definition": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-13-Dispense-to Location; RXD-30-Dispense to Pharmacy; RXD-31-Dispense to Pharmacy Address (V2 (in definition of RXD-13, RXD-30 and RXD-31) directs use of the PRT segment but there doesn't appear to be a standard code in Table 0912 suitable for PRT-4-Participation)"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"path": "MedicationDispense.receiver",
"short": "Who collected the medication",
"definition": "Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
},
{
"path": "MedicationDispense.note",
"short": "Information about the dispense",
"definition": "Extra information about the dispense that could not be conveyed in the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationDispense.dosageInstruction",
"short": "Medicine administration instructions to the patient/carer",
"definition": "Indicates how the medication is to be used by the patient.",
"comments": "When the dose or rate is intended to change over the entire administration period, eg. Tapering dose prescriptions, multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.additionalInstructions",
"short": "E.g. \"Take with food\"",
"definition": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.schedule[x]",
"short": "When medication should be administered",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RDS:TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.site",
"short": "Body site to administer to",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.route",
"short": "How drug should enter body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.method",
"short": "Technique for administering medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.\rIf the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.rate",
"short": "Amount of medication per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"comments": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied.\rIf the rate is intended to change over time, each change should be captured as a distinct \"dosage\" repetition, except for titration orders.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
},
{
"path": "MedicationDispense.substitution",
"short": "Deals with substitution of one medicine for another",
"definition": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
},
{
"path": "MedicationDispense.substitution.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationDispense.substitution.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationDispense.substitution.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationDispense.substitution.type",
"short": "Type of substitiution",
"definition": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionType",
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "MedicationDispense.substitution.reason",
"short": "Why was substitution made",
"definition": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "MedicationDispense.substitution.responsibleParty",
"short": "Who is responsible for the substitution",
"definition": "The person or organization that has primary responsibility for the substitution.",
"comments": "rename.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "MedicationDispense",
"short": "Dispensing a medication to a named patient",
"definition": "Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "mdd-1",
"name": "Timing",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
}
]
},
{
"path": "MedicationDispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "MedicationDispense.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"strength": "required",
"description": "A code specifying the state of the dispense event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "(Not clear whether or how V2 provides for a snapshot of dispense status)"
},
{
"identity": "rim",
"map": ".status"
}
]
},
{
"path": "MedicationDispense.patient",
"short": "Who the dispense is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "MedicationDispense.dispenser",
"short": "Practitioner responsible for dispensing medication",
"definition": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
},
{
"path": "MedicationDispense.authorizingPrescription",
"short": "Medication order that authorizes the dispense",
"definition": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
}
]
},
{
"path": "MedicationDispense.type",
"short": "Trial fill, partial fill, emergency fill, etc.",
"definition": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationDispenseType",
"strength": "example",
"description": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "MedicationDispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "MedicationDispense.daysSupply",
"short": "Days Supply",
"definition": "The amount of medication expressed as a timing amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "MedicationDispense.medication",
"short": "What medication was supplied",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "MedicationDispense.whenPrepared",
"short": "Dispense processing time",
"definition": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
}
]
},
{
"path": "MedicationDispense.whenHandedOver",
"short": "Handover time",
"definition": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
}
]
},
{
"path": "MedicationDispense.destination",
"short": "Where the medication was sent",
"definition": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-13-Dispense-to Location; RXD-30-Dispense to Pharmacy; RXD-31-Dispense to Pharmacy Address (V2 (in definition of RXD-13, RXD-30 and RXD-31) directs use of the PRT segment but there doesn't appear to be a standard code in Table 0912 suitable for PRT-4-Participation)"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"path": "MedicationDispense.receiver",
"short": "Who collected the medication",
"definition": "Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
},
{
"path": "MedicationDispense.note",
"short": "Information about the dispense",
"definition": "Extra information about the dispense that could not be conveyed in the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationDispense.dosageInstruction",
"short": "Medicine administration instructions to the patient/carer",
"definition": "Indicates how the medication is to be used by the patient.",
"comments": "When the dose or rate is intended to change over the entire administration period, eg. Tapering dose prescriptions, multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.additionalInstructions",
"short": "E.g. \"Take with food\"",
"definition": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.schedule[x]",
"short": "When medication should be administered",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RDS:TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.site",
"short": "Body site to administer to",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.route",
"short": "How drug should enter body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.method",
"short": "Technique for administering medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.\rIf the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.rate",
"short": "Amount of medication per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"comments": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied.\rIf the rate is intended to change over time, each change should be captured as a distinct \"dosage\" repetition, except for titration orders.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "MedicationDispense.dosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
},
{
"path": "MedicationDispense.substitution",
"short": "Deals with substitution of one medicine for another",
"definition": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
},
{
"path": "MedicationDispense.substitution.type",
"short": "Type of substitiution",
"definition": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionType",
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "MedicationDispense.substitution.reason",
"short": "Why was substitution made",
"definition": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "MedicationDispense.substitution.responsibleParty",
"short": "Who is responsible for the substitution",
"definition": "The person or organization that has primary responsibility for the substitution.",
"comments": "rename.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "MedicationPrescription",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription",
"name": "MedicationPrescription",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MedicationPrescription Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "MedicationPrescription",
"short": "Prescription of medication to for patient",
"definition": "An order for both supply of the medication and the instructions for administration of the medicine to a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "MedicationPrescription"
}
],
"mapping": [
{
"identity": "rim",
"map": "CombinedMedicationRequest"
}
]
},
{
"path": "MedicationPrescription.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "MedicationPrescription.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "MedicationPrescription.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "MedicationPrescription.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "MedicationPrescription.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "MedicationPrescription.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.identifier",
"short": "External identifier",
"definition": "External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "MedicationPrescription.dateWritten",
"short": "When prescription was authorized",
"definition": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "MedicationPrescription.status",
"short": "active | on-hold | completed | entered-in-error | stopped | superceded | draft",
"definition": "A code specifying the state of the order. Generally this will be active or completed state.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationPrescriptionStatus",
"strength": "required",
"description": "A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-prescription-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
},
{
"path": "MedicationPrescription.patient",
"short": "Who prescription is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
}
]
},
{
"path": "MedicationPrescription.prescriber",
"short": "Who ordered the medication(s)",
"definition": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity": "rim",
"map": "author.role"
}
]
},
{
"path": "MedicationPrescription.encounter",
"short": "Created during encounter / admission / stay",
"definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.",
"comments": "SubstanceAdministration->component->EncounterEvent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"path": "MedicationPrescription.reason[x]",
"short": "Reason or indication for writing the prescription",
"definition": "Can be the reason or the indication for writing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation\ror\rreason.observation[code=ASSERTION].value"
}
]
},
{
"path": "MedicationPrescription.note",
"short": "Information about the prescription",
"definition": "Extra information about the prescription that could not be conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationPrescription.medication",
"short": "Medication to be taken",
"definition": "Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.administrableMedication"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction",
"short": "How medication should be taken",
"definition": "Indicates how the medication is to be used by the patient.",
"comments": "When the dose or rate is intended to change over the entire administration period, eg. Tapering dose prescriptions, multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "component.substanceAdministrationRequest"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.text",
"short": "Dosage instructions expressed as text",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction"
},
{
"identity": "rim",
"map": "text"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.additionalInstructions",
"short": "Supplemental instructions - e.g. \"with meals\"",
"definition": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"
},
{
"identity": "rim",
"map": "component.substanceAdministrationRequest.text"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.scheduled[x]",
"short": "When medication should be administered",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RDS:TQ1"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.site",
"short": "Body site to administer to",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": "approachSiteCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.route",
"short": "How drug should enter body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": "routeCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.method",
"short": "Technique for administering medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.\rIf the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
},
{
"identity": "rim",
"map": "doseQuantity"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.rate",
"short": "Amount of medication per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"comments": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied.\rIf the rate is intended to change over time, each change should be captured as a distinct \"dosage\" repetition, except for titration orders.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
},
{
"identity": "rim",
"map": "rateQuantity"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"comments": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets ever 4 hours to a maximum of 8/day\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": "maxDoseQuantity"
}
]
},
{
"path": "MedicationPrescription.dispense",
"short": "Medication supply authorization",
"definition": "Deals with details of the dispense part of the order.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"path": "MedicationPrescription.dispense.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.dispense.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.dispense.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.dispense.medication",
"short": "Product to be supplied",
"definition": "Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.role"
}
]
},
{
"path": "MedicationPrescription.dispense.validityPeriod",
"short": "Time period supply is authorized for",
"definition": "Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \rIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \rRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationPrescription.dispense.numberOfRepeatsAllowed",
"short": "# of refills authorized",
"definition": "An integer indicating the number of repeats of the Dispense. \rUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.",
"comments": "If displaying \"number of authorized refills\", subtract 1 from this number.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-12-Number of Refills"
},
{
"identity": "rim",
"map": "repeatNumber"
}
]
},
{
"path": "MedicationPrescription.dispense.quantity",
"short": "Amount of medication to supply per dispense",
"definition": "The amount that is to be dispensed for one fill.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": "quantity"
}
]
},
{
"path": "MedicationPrescription.dispense.expectedSupplyDuration",
"short": "Days supply per dispense",
"definition": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \rIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "rim",
"map": "expectedUseTime"
}
]
},
{
"path": "MedicationPrescription.substitution",
"short": "Any restrictions on medication substitution?",
"definition": "Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "subjectOf.substitutionPersmission"
}
]
},
{
"path": "MedicationPrescription.substitution.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.substitution.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationPrescription.substitution.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationPrescription.substitution.type",
"short": "generic | formulary +",
"definition": "A code signifying whether a different drug should be dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionType",
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-9-Allow Substitutions / RXE-9-Substitution Status?"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "MedicationPrescription.substitution.reason",
"short": "Why should substitution (not) be made",
"definition": "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": "reasonCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "MedicationPrescription",
"short": "Prescription of medication to for patient",
"definition": "An order for both supply of the medication and the instructions for administration of the medicine to a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "CombinedMedicationRequest"
}
]
},
{
"path": "MedicationPrescription.identifier",
"short": "External identifier",
"definition": "External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "MedicationPrescription.dateWritten",
"short": "When prescription was authorized",
"definition": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "MedicationPrescription.status",
"short": "active | on-hold | completed | entered-in-error | stopped | superceded | draft",
"definition": "A code specifying the state of the order. Generally this will be active or completed state.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationPrescriptionStatus",
"strength": "required",
"description": "A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-prescription-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
},
{
"path": "MedicationPrescription.patient",
"short": "Who prescription is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
}
]
},
{
"path": "MedicationPrescription.prescriber",
"short": "Who ordered the medication(s)",
"definition": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity": "rim",
"map": "author.role"
}
]
},
{
"path": "MedicationPrescription.encounter",
"short": "Created during encounter / admission / stay",
"definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.",
"comments": "SubstanceAdministration->component->EncounterEvent.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"path": "MedicationPrescription.reason[x]",
"short": "Reason or indication for writing the prescription",
"definition": "Can be the reason or the indication for writing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation\ror\rreason.observation[code=ASSERTION].value"
}
]
},
{
"path": "MedicationPrescription.note",
"short": "Information about the prescription",
"definition": "Extra information about the prescription that could not be conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationPrescription.medication",
"short": "Medication to be taken",
"definition": "Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.administrableMedication"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction",
"short": "How medication should be taken",
"definition": "Indicates how the medication is to be used by the patient.",
"comments": "When the dose or rate is intended to change over the entire administration period, eg. Tapering dose prescriptions, multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "component.substanceAdministrationRequest"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.text",
"short": "Dosage instructions expressed as text",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction"
},
{
"identity": "rim",
"map": "text"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.additionalInstructions",
"short": "Supplemental instructions - e.g. \"with meals\"",
"definition": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"
},
{
"identity": "rim",
"map": "component.substanceAdministrationRequest.text"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.scheduled[x]",
"short": "When medication should be administered",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RDS:TQ1"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.site",
"short": "Body site to administer to",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": "approachSiteCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.route",
"short": "How drug should enter body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": "routeCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.method",
"short": "Technique for administering medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.\rIf the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
},
{
"identity": "rim",
"map": "doseQuantity"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.rate",
"short": "Amount of medication per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"comments": "It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied.\rIf the rate is intended to change over time, each change should be captured as a distinct \"dosage\" repetition, except for titration orders.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
},
{
"identity": "rim",
"map": "rateQuantity"
}
]
},
{
"path": "MedicationPrescription.dosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"comments": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets ever 4 hours to a maximum of 8/day\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": "maxDoseQuantity"
}
]
},
{
"path": "MedicationPrescription.dispense",
"short": "Medication supply authorization",
"definition": "Deals with details of the dispense part of the order.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"path": "MedicationPrescription.dispense.medication",
"short": "Product to be supplied",
"definition": "Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.role"
}
]
},
{
"path": "MedicationPrescription.dispense.validityPeriod",
"short": "Time period supply is authorized for",
"definition": "Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \rIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \rRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "MedicationPrescription.dispense.numberOfRepeatsAllowed",
"short": "# of refills authorized",
"definition": "An integer indicating the number of repeats of the Dispense. \rUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.",
"comments": "If displaying \"number of authorized refills\", subtract 1 from this number.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-12-Number of Refills"
},
{
"identity": "rim",
"map": "repeatNumber"
}
]
},
{
"path": "MedicationPrescription.dispense.quantity",
"short": "Amount of medication to supply per dispense",
"definition": "The amount that is to be dispensed for one fill.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": "quantity"
}
]
},
{
"path": "MedicationPrescription.dispense.expectedSupplyDuration",
"short": "Days supply per dispense",
"definition": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \rIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
],
"mapping": [
{
"identity": "rim",
"map": "expectedUseTime"
}
]
},
{
"path": "MedicationPrescription.substitution",
"short": "Any restrictions on medication substitution?",
"definition": "Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "subjectOf.substitutionPersmission"
}
]
},
{
"path": "MedicationPrescription.substitution.type",
"short": "generic | formulary +",
"definition": "A code signifying whether a different drug should be dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionType",
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-9-Allow Substitutions / RXE-9-Substitution Status?"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "MedicationPrescription.substitution.reason",
"short": "Why should substitution (not) be made",
"definition": "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": "reasonCode"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "MedicationStatement",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/MedicationStatement",
"name": "MedicationStatement",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MedicationStatement Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "MedicationStatement",
"short": "Administration of medication to a patient",
"definition": "A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.",
"min": 1,
"max": "1",
"type": [
{
"code": "MedicationStatement"
}
],
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "MedicationStatement.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "MedicationStatement.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "MedicationStatement.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "MedicationStatement.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "MedicationStatement.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "MedicationStatement.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationStatement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationStatement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationStatement.identifier",
"short": "External Identifier",
"definition": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier?"
},
{
"identity": "rim",
"map": "SubstanceAdministration.id"
}
]
},
{
"path": "MedicationStatement.patient",
"short": "Who was/is taking medication",
"definition": "The person or animal who is /was taking the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "SubstanceAdministration->subject->Patient"
}
]
},
{
"path": "MedicationStatement.informationSource",
"short": "The person who provided the information about the taking of this medication.",
"definition": "The person who provided the information about the taking of this medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "MedicationStatement.dateAsserted",
"short": "When the statement was asserted?",
"definition": "The date when the medication statement was asserted by the information source.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "MedicationStatement.status",
"short": "in-progress | completed | entered-in-error",
"definition": "A code specifying the state of the statement. Generally this will be in-progress or completed state.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MedicationStatementStatus",
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationStatement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-statement-status"
}
}
},
{
"path": "MedicationStatement.wasNotGiven",
"short": "True if medication is/was not being taken",
"definition": "Set this to true if the record is saying that the medication was NOT taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "SubstanceAdministration.actionNegationInd"
}
]
},
{
"path": "MedicationStatement.reasonNotGiven",
"short": "True if asserting medication was not given",
"definition": "A code indicating why the medication was not taken.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mst-1"
],
"constraint": [
{
"key": "mst-1",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')"
}
],
"binding": {
"name": "MedicationAdministrationNegationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "SubstanceAdministration->Reason->Observation->Value"
}
]
},
{
"path": "MedicationStatement.reasonForUse[x]",
"short": "A reason for why the medication is being/was taken.",
"definition": "A reason for why the medication is being/was taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"constraint": [
{
"key": "mst-2",
"name": "Reason for use",
"severity": "error",
"human": "Reason for use is only permitted if wasNotGiven is false",
"xpath": "not(exists(f:reasonForUse[x]) and f:wasNotGiven/@value='true')"
}
]
},
{
"path": "MedicationStatement.effective[x]",
"short": "Over what period was medication consumed?",
"definition": "The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the 'wasNotGiven' attribute is true).",
"comments": "If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": "SubstanceAdministration.effectiveTime"
}
]
},
{
"path": "MedicationStatement.note",
"short": "Further information about the statement",
"definition": "Provides extra information about the medication statement that is not conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationStatement.medication",
"short": "What medication was taken?",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the medication this statement concerns. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest.consumable"
}
]
},
{
"path": "MedicationStatement.dosage",
"short": "Details of how medication was taken",
"definition": "Indicates how the medication is/was used by the patient.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest"
}
]
},
{
"path": "MedicationStatement.dosage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationStatement.dosage.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MedicationStatement.dosage.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MedicationStatement.dosage.text",
"short": "Dosage Instructions",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationStatement.dosage.schedule",
"short": "When/how often was medication taken?",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RAS:TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "MedicationStatement.dosage.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationStatement.dosage.site",
"short": "Where on body was medication administered?",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "MedicationStatement.dosage.route",
"short": "How did the medication enter the body?",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "MedicationStatement.dosage.method",
"short": "Technique used to administer medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "MedicationStatement.dosage.quantity",
"short": "Amount administered in one dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "MedicationStatement.dosage.rate",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "MedicationStatement.dosage.maxDosePerPeriod",
"short": "Maximum dose that was consumed per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
}
]
},
"differential": {
"element": [
{
"path": "MedicationStatement",
"short": "Administration of medication to a patient",
"definition": "A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
},
{
"path": "MedicationStatement.identifier",
"short": "External Identifier",
"definition": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier?"
},
{
"identity": "rim",
"map": "SubstanceAdministration.id"
}
]
},
{
"path": "MedicationStatement.patient",
"short": "Who was/is taking medication",
"definition": "The person or animal who is /was taking the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "SubstanceAdministration->subject->Patient"
}
]
},
{
"path": "MedicationStatement.informationSource",
"short": "The person who provided the information about the taking of this medication.",
"definition": "The person who provided the information about the taking of this medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "MedicationStatement.dateAsserted",
"short": "When the statement was asserted?",
"definition": "The date when the medication statement was asserted by the information source.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "MedicationStatement.status",
"short": "in-progress | completed | entered-in-error",
"definition": "A code specifying the state of the statement. Generally this will be in-progress or completed state.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "MedicationStatementStatus",
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationStatement",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-statement-status"
}
}
},
{
"path": "MedicationStatement.wasNotGiven",
"short": "True if medication is/was not being taken",
"definition": "Set this to true if the record is saying that the medication was NOT taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "SubstanceAdministration.actionNegationInd"
}
]
},
{
"path": "MedicationStatement.reasonNotGiven",
"short": "True if asserting medication was not given",
"definition": "A code indicating why the medication was not taken.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mst-1"
],
"constraint": [
{
"key": "mst-1",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')"
}
],
"binding": {
"name": "MedicationAdministrationNegationReason",
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": "SubstanceAdministration->Reason->Observation->Value"
}
]
},
{
"path": "MedicationStatement.reasonForUse[x]",
"short": "A reason for why the medication is being/was taken.",
"definition": "A reason for why the medication is being/was taken.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"constraint": [
{
"key": "mst-2",
"name": "Reason for use",
"severity": "error",
"human": "Reason for use is only permitted if wasNotGiven is false",
"xpath": "not(exists(f:reasonForUse[x]) and f:wasNotGiven/@value='true')"
}
]
},
{
"path": "MedicationStatement.effective[x]",
"short": "Over what period was medication consumed?",
"definition": "The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the 'wasNotGiven' attribute is true).",
"comments": "If the medication is still being taken at the time the statement is recorded, the \"end\" date will be omitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": "SubstanceAdministration.effectiveTime"
}
]
},
{
"path": "MedicationStatement.note",
"short": "Further information about the statement",
"definition": "Provides extra information about the medication statement that is not conveyed by the other attributes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationStatement.medication",
"short": "What medication was taken?",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "Note: do not use Medication.name to describe the medication this statement concerns. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest.consumable"
}
]
},
{
"path": "MedicationStatement.dosage",
"short": "Details of how medication was taken",
"definition": "Indicates how the medication is/was used by the patient.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration>Component>SubstanceAdministrationRequest"
}
]
},
{
"path": "MedicationStatement.dosage.text",
"short": "Dosage Instructions",
"definition": "Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "MedicationStatement.dosage.schedule",
"short": "When/how often was medication taken?",
"definition": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "RAS:TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "MedicationStatement.dosage.asNeeded[x]",
"short": "Take \"as needed\" f(or x)",
"definition": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAsNeededReason",
"strength": "required",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\r\rCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
},
{
"path": "MedicationStatement.dosage.site",
"short": "Where on body was medication administered?",
"definition": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationSite",
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2-Administration Site"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "MedicationStatement.dosage.route",
"short": "How did the medication enter the body?",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RouteOfAdministration",
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "MedicationStatement.dosage.method",
"short": "Technique used to administer medication",
"definition": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\r\rTerminologies used often pre-coordinate this term with the route and or form of administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationAdministrationMethod",
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "MedicationStatement.dosage.quantity",
"short": "Amount administered in one dose",
"definition": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "MedicationStatement.dosage.rate",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "MedicationStatement.dosage.maxDosePerPeriod",
"short": "Maximum dose that was consumed per unit of time",
"definition": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "MessageHeader",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"name": "MessageHeader",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MessageHeader Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "MessageHeader",
"short": "A resource that describes a message that is exchanged between systems",
"definition": "The header for a message exchange that is either requesting or responding to an action. The Reference(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"requirements": "Many implementations are not prepared to use REST and need a messaging based infrastructure.",
"min": 1,
"max": "1",
"type": [
{
"code": "MessageHeader"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH / MSA / ERR"
},
{
"identity": "rim",
"map": "Message"
}
]
},
{
"path": "MessageHeader.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "MessageHeader.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "MessageHeader.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "MessageHeader.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "MessageHeader.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "MessageHeader.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.identifier",
"short": "Id of this message",
"definition": "The identifier of this message.",
"comments": "This SHALL be unique within the scope of this stream of messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-10-message control ID"
},
{
"identity": "rim",
"map": "Message.id"
}
]
},
{
"path": "MessageHeader.timestamp",
"short": "Time that the message was sent",
"definition": "The time that the message was sent.",
"requirements": "Allows limited detection of out-of-order and delayed transmission. Also supports audit.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-7-message date/time"
},
{
"identity": "rim",
"map": "./creationTime[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.event",
"short": "Code for the event this message represents",
"definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\".",
"requirements": "Drives the behavior associated with this message.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": true,
"binding": {
"name": "MessageEvent",
"strength": "preferred",
"description": "One of the message events defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-events"
}
},
"mapping": [
{
"identity": "v2",
"map": "MSH-9.2-message type.trigger event"
},
{
"identity": "rim",
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
}
]
},
{
"path": "MessageHeader.response",
"short": "If this is a reply to prior message",
"definition": "Information about the message that this message is a response to. Only present if this message is a response.",
"min": 0,
"max": "1",
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "MSA"
},
{
"identity": "rim",
"map": "./conveyedAcknowledgement"
}
]
},
{
"path": "MessageHeader.response.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.response.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.response.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.response.identifier",
"short": "Id of original message",
"definition": "The id of the message that this message is a response to.",
"requirements": "Allows receiver to know what message is being responded to.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSA-2-message control ID"
},
{
"identity": "rim",
"map": "./acknowledges.id[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.response.code",
"short": "ok | transient-error | fatal-error",
"definition": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"comments": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.",
"requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ResponseType",
"strength": "required",
"description": "The kind of response to a message",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/response-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "MSA-1-acknowledgment code"
},
{
"identity": "rim",
"map": "./typeCode[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.response.details",
"short": "Specific list of hints/warnings/errors",
"definition": "Full details of any issues found in the message.",
"comments": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"requirements": "Allows the sender of the message to determine what the specific issues are.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR"
},
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "MessageHeader.source",
"short": "Message Source Application",
"definition": "The source application from which this message originated.",
"requirements": "Allows replies, supports audit.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "unique(./communicationFunction[typeCode=\"SND\"])"
}
]
},
{
"path": "MessageHeader.source.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.source.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.source.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.source.name",
"short": "Name of system",
"definition": "Human-readable name for the source system.",
"requirements": "May be used to support audit.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-3-sending application"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.software",
"short": "Name of software running the system",
"definition": "May include configuration or other information useful in debugging.",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "SFT-3-software product name ( +SFT-1-software vendor organization)"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.version",
"short": "Version of software running",
"definition": "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "SFT-2-software certified version or release number"
},
{
"identity": "rim",
"map": "(Not supported)"
}
]
},
{
"path": "MessageHeader.source.contact",
"short": "Human contact for problems",
"definition": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"requirements": "Allows escalation of technical issues.",
"min": 0,
"max": "1",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "(MSH-22?)"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.endpoint",
"short": "Actual message source address or id",
"definition": "Identifies the routing target to send acknowledgements to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements": "Identifies where to send responses, may influence security permissions.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-24-sending network address"
},
{
"identity": "rim",
"map": "./telecom[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.destination",
"short": "Message Destination Application(s)",
"definition": "The destination application which the message is intended for.",
"comments": "there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"requirements": "Indicates where message is to be sent to for routing purposes. Allows verification of \"am I the intended recipient\".",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./communicationFunction[typeCode=\"RCV\"]"
}
]
},
{
"path": "MessageHeader.destination.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.destination.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "MessageHeader.destination.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "MessageHeader.destination.name",
"short": "Name of system",
"definition": "Human-readable name for the target system.",
"requirements": "May be used for routing of response and/or to support audit.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-5-receiving application"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.destination.target",
"short": "Particular delivery destination within the destination",
"definition": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"requirements": "Supports multi-hop routing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}
]
},
{
"path": "MessageHeader.destination.endpoint",
"short": "Actual destination address or id",
"definition": "Indicates where the message should be routed to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements": "Identifies where to route the message.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-25-receiving network address (or MSH-6-receiving facility by implication)"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "MessageHeader.enterer",
"short": "The source of the data entry",
"definition": "The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "EVN-5-operator ID / ORC-10-entered by / PRT-5-Participation Person:PRT-4-Participation='EP' / ROL where ROL.3 is EP or ORC.10"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.author",
"short": "The source of the decision",
"definition": "The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.receiver",
"short": "Intended \"real-world\" recipient for the data",
"definition": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Participation='WAYR'"
},
{
"identity": "rim",
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
}
]
},
{
"path": "MessageHeader.responsible",
"short": "Final responsibility for event",
"definition": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12-ordering provider / \nPRT-5-Participation Person:PRT-4-Participation='OP' / \nPRT-8-Participation Organization:PRT-4-Participation='OP'\n/ ROL where ROL.3 is RO or ORC.11"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.reason",
"short": "Cause of event",
"definition": "Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.",
"requirements": "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EventReason",
"strength": "example",
"description": "Reason for event occurrence",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-reason-encounter"
}
},
"mapping": [
{
"identity": "v2",
"map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.data",
"short": "The actual content of the message",
"definition": "The actual data of the message - a reference to the root/focus class of the event.",
"comments": "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"requirements": "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "MessageHeader",
"short": "A resource that describes a message that is exchanged between systems",
"definition": "The header for a message exchange that is either requesting or responding to an action. The Reference(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.",
"requirements": "Many implementations are not prepared to use REST and need a messaging based infrastructure.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH / MSA / ERR"
},
{
"identity": "rim",
"map": "Message"
}
]
},
{
"path": "MessageHeader.identifier",
"short": "Id of this message",
"definition": "The identifier of this message.",
"comments": "This SHALL be unique within the scope of this stream of messages.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-10-message control ID"
},
{
"identity": "rim",
"map": "Message.id"
}
]
},
{
"path": "MessageHeader.timestamp",
"short": "Time that the message was sent",
"definition": "The time that the message was sent.",
"requirements": "Allows limited detection of out-of-order and delayed transmission. Also supports audit.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-7-message date/time"
},
{
"identity": "rim",
"map": "./creationTime[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.event",
"short": "Code for the event this message represents",
"definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://hl7.org/fhir/message-type\".",
"requirements": "Drives the behavior associated with this message.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isModifier": true,
"binding": {
"name": "MessageEvent",
"strength": "preferred",
"description": "One of the message events defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-events"
}
},
"mapping": [
{
"identity": "v2",
"map": "MSH-9.2-message type.trigger event"
},
{
"identity": "rim",
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
}
]
},
{
"path": "MessageHeader.response",
"short": "If this is a reply to prior message",
"definition": "Information about the message that this message is a response to. Only present if this message is a response.",
"min": 0,
"max": "1",
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "MSA"
},
{
"identity": "rim",
"map": "./conveyedAcknowledgement"
}
]
},
{
"path": "MessageHeader.response.identifier",
"short": "Id of original message",
"definition": "The id of the message that this message is a response to.",
"requirements": "Allows receiver to know what message is being responded to.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSA-2-message control ID"
},
{
"identity": "rim",
"map": "./acknowledges.id[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.response.code",
"short": "ok | transient-error | fatal-error",
"definition": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"comments": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.",
"requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ResponseType",
"strength": "required",
"description": "The kind of response to a message",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/response-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "MSA-1-acknowledgment code"
},
{
"identity": "rim",
"map": "./typeCode[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.response.details",
"short": "Specific list of hints/warnings/errors",
"definition": "Full details of any issues found in the message.",
"comments": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"requirements": "Allows the sender of the message to determine what the specific issues are.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR"
},
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "MessageHeader.source",
"short": "Message Source Application",
"definition": "The source application from which this message originated.",
"requirements": "Allows replies, supports audit.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "unique(./communicationFunction[typeCode=\"SND\"])"
}
]
},
{
"path": "MessageHeader.source.name",
"short": "Name of system",
"definition": "Human-readable name for the source system.",
"requirements": "May be used to support audit.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-3-sending application"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.software",
"short": "Name of software running the system",
"definition": "May include configuration or other information useful in debugging.",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "SFT-3-software product name ( +SFT-1-software vendor organization)"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.version",
"short": "Version of software running",
"definition": "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "SFT-2-software certified version or release number"
},
{
"identity": "rim",
"map": "(Not supported)"
}
]
},
{
"path": "MessageHeader.source.contact",
"short": "Human contact for problems",
"definition": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"requirements": "Allows escalation of technical issues.",
"min": 0,
"max": "1",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "(MSH-22?)"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.source.endpoint",
"short": "Actual message source address or id",
"definition": "Identifies the routing target to send acknowledgements to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements": "Identifies where to send responses, may influence security permissions.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-24-sending network address"
},
{
"identity": "rim",
"map": "./telecom[isNormalDatatype()]"
}
]
},
{
"path": "MessageHeader.destination",
"short": "Message Destination Application(s)",
"definition": "The destination application which the message is intended for.",
"comments": "there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"requirements": "Indicates where message is to be sent to for routing purposes. Allows verification of \"am I the intended recipient\".",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./communicationFunction[typeCode=\"RCV\"]"
}
]
},
{
"path": "MessageHeader.destination.name",
"short": "Name of system",
"definition": "Human-readable name for the target system.",
"requirements": "May be used for routing of response and/or to support audit.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-5-receiving application"
},
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.destination.target",
"short": "Particular delivery destination within the destination",
"definition": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"requirements": "Supports multi-hop routing.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}
]
},
{
"path": "MessageHeader.destination.endpoint",
"short": "Actual destination address or id",
"definition": "Indicates where the message should be routed to.",
"comments": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"requirements": "Identifies where to route the message.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "v2",
"map": "MSH-25-receiving network address (or MSH-6-receiving facility by implication)"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "MessageHeader.enterer",
"short": "The source of the data entry",
"definition": "The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "EVN-5-operator ID / ORC-10-entered by / PRT-5-Participation Person:PRT-4-Participation='EP' / ROL where ROL.3 is EP or ORC.10"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.author",
"short": "The source of the decision",
"definition": "The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.receiver",
"short": "Intended \"real-world\" recipient for the data",
"definition": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Participation='WAYR'"
},
{
"identity": "rim",
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText"
}
]
},
{
"path": "MessageHeader.responsible",
"short": "Final responsibility for event",
"definition": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"comments": "Usually only for the request, but can be used in a response.",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12-ordering provider / \nPRT-5-Participation Person:PRT-4-Participation='OP' / \nPRT-8-Participation Organization:PRT-4-Participation='OP'\n/ ROL where ROL.3 is RO or ORC.11"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])"
}
]
},
{
"path": "MessageHeader.reason",
"short": "Cause of event",
"definition": "Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.",
"requirements": "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EventReason",
"strength": "example",
"description": "Reason for event occurrence",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/message-reason-encounter"
}
},
"mapping": [
{
"identity": "v2",
"map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication"
},
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
}
]
},
{
"path": "MessageHeader.data",
"short": "The actual content of the message",
"definition": "The actual data of the message - a reference to the root/focus class of the event.",
"comments": "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"requirements": "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "NamingSystem",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/NamingSystem",
"name": "NamingSystem",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for NamingSystem Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "NamingSystem",
"short": "System of unique identification",
"definition": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min": 1,
"max": "1",
"type": [
{
"code": "NamingSystem"
}
],
"constraint": [
{
"key": "nsd-2",
"severity": "error",
"human": "Can't have more than one preferred identifier for a type",
"xpath": "not(exists(for $type in distinct-values(f:uniqueId/f:type) return if (count(f:uniqueId[f:type/@value=$type and f:primary/@value='true'])>1) then $type else ()))"
},
{
"key": "nsd-3",
"severity": "error",
"human": "Can only have replacedBy if namingsystem is retired",
"xpath": "not(f:replacedBy) or f:status/@value='retired'"
},
{
"key": "nsd-1",
"severity": "error",
"human": "Root systems cannot have uuid or sid identifiers",
"xpath": "not(f:type/@value='root' and f:uniqueId/f:type=('uuid', 'ruid'))"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "NamingSystem.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "NamingSystem.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "NamingSystem.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "NamingSystem.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "NamingSystem.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.type",
"short": "codesystem | identifier | root",
"definition": "Indicates the purpose for the namingsystem - what kinds of things does it make unique?",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "NamingSystemType",
"strength": "required",
"description": "Identifies the purpose of the namingsystem",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/namingsystem-type"
}
}
},
{
"path": "NamingSystem.name",
"short": "Human-readable label",
"definition": "The descriptive name of this particular identifier type or code system.",
"comments": "The\"symbolic name\" for an OID would be captured as an extension.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the system was registered or published.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "NamingSystem.status",
"short": "draft | active | retired",
"definition": "Indicates whether the namingsystem is \"ready for use\" or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "NamingSystem.country",
"short": "ISO 3-char country code",
"definition": "If present, indicates that the identifier or code system is principally intended for use or applies to entities within the specified country. For example, the country associated with a national code system.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Country",
"strength": "required",
"description": "Codes for identifying countries",
"valueSetUri": "http://www.iso.org/iso/country_codes"
}
},
{
"path": "NamingSystem.category",
"short": "e.g. driver, provider, patient, bank etc",
"definition": "Categorizes a namingsystem for easier search by grouping related namingsystems.",
"comments": "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NamingSystemCategory",
"strength": "required",
"description": "Identifies the general purpose of the namingsystem identifiers provided. E.g. Driver, Provider, Patient, Bank, etc."
}
},
{
"path": "NamingSystem.responsible",
"short": "Who maintains system namespace?",
"definition": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comments": "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.description",
"short": "What does namingsystem identify?",
"definition": "Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.usage",
"short": "How/where is it used",
"definition": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.uniqueId",
"short": "Unique identifiers used for system",
"definition": "Indicates how the system may be identified when referenced in electronic exchange.",
"comments": "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min": 1,
"max": "*"
},
{
"path": "NamingSystem.uniqueId.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NamingSystem.uniqueId.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NamingSystem.uniqueId.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.uniqueId.type",
"short": "oid | uuid | uri | other",
"definition": "Identifies the unique identifier scheme used for this particular identifier.",
"comments": "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "NamingSystemIdentifierType",
"strength": "required",
"description": "Identifies the style of unique identifier used to identify a namepace",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/namingsystem-identifier-type"
}
}
},
{
"path": "NamingSystem.uniqueId.value",
"short": "The unique identifier",
"definition": "The string that should be sent over the wire to identify the code system or identifier system.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.uniqueId.preferred",
"short": "Is this the id that should be used for this type",
"definition": "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "NamingSystem.uniqueId.period",
"short": "When is identifier valid?",
"definition": "Identifies the period of time over which this identifier is considered appropriate to refer to the namingsystem. Outside of this window, the identifier might be non-deterministic.",
"comments": "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "NamingSystem.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the naming system.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "NamingSystem.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "NamingSystem.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NamingSystem.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NamingSystem.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the naming system.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "NamingSystem.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "NamingSystem.replacedBy",
"short": "Use this instead",
"definition": "For namingsystems that are retired, indicates the namingsystem that should be used in their place (if any).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
}
],
"condition": [
"nsd-3"
]
}
]
},
"differential": {
"element": [
{
"path": "NamingSystem",
"short": "System of unique identification",
"definition": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "nsd-2",
"severity": "error",
"human": "Can't have more than one preferred identifier for a type",
"xpath": "not(exists(for $type in distinct-values(f:uniqueId/f:type) return if (count(f:uniqueId[f:type/@value=$type and f:primary/@value='true'])>1) then $type else ()))"
},
{
"key": "nsd-3",
"severity": "error",
"human": "Can only have replacedBy if namingsystem is retired",
"xpath": "not(f:replacedBy) or f:status/@value='retired'"
},
{
"key": "nsd-1",
"severity": "error",
"human": "Root systems cannot have uuid or sid identifiers",
"xpath": "not(f:type/@value='root' and f:uniqueId/f:type=('uuid', 'ruid'))"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NamingSystem.type",
"short": "codesystem | identifier | root",
"definition": "Indicates the purpose for the namingsystem - what kinds of things does it make unique?",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "NamingSystemType",
"strength": "required",
"description": "Identifies the purpose of the namingsystem",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/namingsystem-type"
}
}
},
{
"path": "NamingSystem.name",
"short": "Human-readable label",
"definition": "The descriptive name of this particular identifier type or code system.",
"comments": "The\"symbolic name\" for an OID would be captured as an extension.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the system was registered or published.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "NamingSystem.status",
"short": "draft | active | retired",
"definition": "Indicates whether the namingsystem is \"ready for use\" or not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "NamingSystem.country",
"short": "ISO 3-char country code",
"definition": "If present, indicates that the identifier or code system is principally intended for use or applies to entities within the specified country. For example, the country associated with a national code system.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Country",
"strength": "required",
"description": "Codes for identifying countries",
"valueSetUri": "http://www.iso.org/iso/country_codes"
}
},
{
"path": "NamingSystem.category",
"short": "e.g. driver, provider, patient, bank etc",
"definition": "Categorizes a namingsystem for easier search by grouping related namingsystems.",
"comments": "This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NamingSystemCategory",
"strength": "required",
"description": "Identifies the general purpose of the namingsystem identifiers provided. E.g. Driver, Provider, Patient, Bank, etc."
}
},
{
"path": "NamingSystem.responsible",
"short": "Who maintains system namespace?",
"definition": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"comments": "This is the primary organization. Responsibility for some aspects of a namespace may be delegated.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.description",
"short": "What does namingsystem identify?",
"definition": "Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.usage",
"short": "How/where is it used",
"definition": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.uniqueId",
"short": "Unique identifiers used for system",
"definition": "Indicates how the system may be identified when referenced in electronic exchange.",
"comments": "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
"min": 1,
"max": "*"
},
{
"path": "NamingSystem.uniqueId.type",
"short": "oid | uuid | uri | other",
"definition": "Identifies the unique identifier scheme used for this particular identifier.",
"comments": "Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.). Other includes RUIDs from v3, standard v2 code name strings, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "NamingSystemIdentifierType",
"strength": "required",
"description": "Identifies the style of unique identifier used to identify a namepace",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/namingsystem-identifier-type"
}
}
},
{
"path": "NamingSystem.uniqueId.value",
"short": "The unique identifier",
"definition": "The string that should be sent over the wire to identify the code system or identifier system.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "NamingSystem.uniqueId.preferred",
"short": "Is this the id that should be used for this type",
"definition": "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "NamingSystem.uniqueId.period",
"short": "When is identifier valid?",
"definition": "Identifies the period of time over which this identifier is considered appropriate to refer to the namingsystem. Outside of this window, the identifier might be non-deterministic.",
"comments": "Within a registry, a given identifier should only be \"active\" for a single namespace at a time. (Ideally, an identifier should only ever be associated with a single namespace across all time).",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "NamingSystem.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the naming system.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the naming system. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "NamingSystem.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "NamingSystem.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the naming system.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "NamingSystem.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "NamingSystem.replacedBy",
"short": "Use this instead",
"definition": "For namingsystems that are retired, indicates the namingsystem that should be used in their place (if any).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NamingSystem"
}
],
"condition": [
"nsd-3"
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "NutritionOrder",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/NutritionOrder",
"name": "NutritionOrder",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for NutritionOrder Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "NutritionOrder",
"short": "A request for a diet, formula or nutritional supplement",
"definition": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"comments": "Referenced by an Order Request (workflow).",
"alias": [
"Diet Order",
"Diet",
"Nutritional Supplement",
"Enteral Nutrition"
],
"min": 1,
"max": "1",
"type": [
{
"code": "NutritionOrder"
}
],
"constraint": [
{
"key": "nor-1",
"name": "nutrition item type",
"severity": "warning",
"human": "Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class",
"xpath": "exists(f:oralDiet) or exists(f:supplement) or exists(f:enteralFormula)"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC / ODS"
},
{
"identity": "rim",
"map": "SupplyRequest"
}
]
},
{
"path": "NutritionOrder.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "NutritionOrder.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "NutritionOrder.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "NutritionOrder.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "NutritionOrder.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "NutritionOrder.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.patient",
"short": "The person who requires the diet, formula or nutritional supplement",
"definition": "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "NutritionOrder.orderer",
"short": "Who ordered the diet, formula or nutritional supplement",
"definition": "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-12"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "NutritionOrder.identifier",
"short": "Identifiers assigned to this order",
"definition": "Identifiers assigned to this order by the order sender or by the order receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2/ORC-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.encounter",
"short": "The encounter associated with that this nutrition order",
"definition": "An encounter that provides additional information about the healthcare context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "NutritionOrder.dateTime",
"short": "Date and time the nutrition order was requested",
"definition": "The date and time that this nutrition order was requested.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "NutritionOrder.status",
"short": "proposed | draft | planned | requested | active | on-hold | completed | cancelled",
"definition": "The workflow status of the nutrition order/request.",
"comments": "Typically the system placing the order sets the status to requested. There after, the order is maintained by the receiver that updates the status as the request is handled.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "NutritionOrderStatus",
"strength": "required",
"description": "Codes specifying the state of the request. Describes the lifecycle of the nutrition order.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/nutrition-order-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-1"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "NutritionOrder.allergyIntolerance",
"short": "List of the patient's food and nutrition-related allergies and intolerances",
"definition": "A link to a record of allergies or Intolerances which should be included in the nutrition order.",
"comments": "Information on a patient's food allergies and intolerances, inform healthcare personnel about the type of foods that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "NutritionOrder.foodPreferenceModifier",
"short": "Order-specific modifier about the type of food that should be given",
"definition": "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comments": "Information on a patient's food preferences inform healthcare personnel about the food that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "PatientDiet",
"strength": "example",
"description": "Medical, cultural or ethical food preferences to help with catering requirements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-diet"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"P\",ODS-3"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=NutritionModificationType]"
}
]
},
{
"path": "NutritionOrder.excludeFoodModifier",
"short": "Order-specific modifier about the type of food that should not be given",
"definition": "This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comments": "Information on a patient's food allergies and intolerances, and preferences inform healthcare personnel about the type of foods that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "FoodType",
"strength": "example",
"description": "Codes used to indicate the type of food that should NOT be given to the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/food-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.oralDiet",
"short": "Oral diet components",
"definition": "Diet given orally in contrast to enteral (tube) feeding.",
"min": 0,
"max": "1",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"D\""
},
{
"identity": "rim",
"map": "oralDiet .outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=OralDietSupplyType]"
}
]
},
{
"path": "NutritionOrder.oralDiet.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.oralDiet.type",
"short": "Type of oral diet or diet restrictions that describe what can be consumed orally",
"definition": "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "OralDiet",
"strength": "example",
"description": "Codes used to indicate the type of diet being ordered for a patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diet-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.scheduled",
"short": "Scheduled frequency of diet",
"definition": "The time period and frequency at which the diet should be given.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2, TQ1-7/8"
},
{
"identity": "rim",
"map": ".expectedUseTime"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient",
"short": "Required nutrient modifications",
"definition": "Class that defines the quantity and type of nutrient modifications required for the oral diet.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.modifier",
"short": "Type of nutrient that is being modified",
"definition": "The nutrient that is being modified such as carbohydrate or sodium.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NutrientModifier",
"strength": "example",
"description": "Codes for types of nutrient that is being modified such as carbohydrate or sodium.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/nutrient-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.amount",
"short": "Quantity of the specified nutrient",
"definition": "The quantity of the specified nutrient to include in diet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture",
"short": "Required texture modifications",
"definition": "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".inboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=DietTextureModificationType]"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.modifier",
"short": "Code to indicate how to alter the texture of the foods, e.g., pureed",
"definition": "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.",
"comments": "Coupled with the foodType (Meat).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "TextureModifier",
"strength": "example",
"description": "Codes for food consistency types or texture modifications to apply to foods.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/texture-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.foodType",
"short": "Concepts that are used to identify an entity that is ingested for nutritional purposes",
"definition": "The food type(s) (e.g., meats, all foods) that the texture modification applies to. This could be all foods types.",
"comments": "Coupled with the textureModifier; could be (All Foods).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "TextureModifiedFoodType",
"strength": "example",
"description": "Codes for types of foods that are texture modified.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modified-foodtype"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code"
}
]
},
{
"path": "NutritionOrder.oralDiet.fluidConsistencyType",
"short": "The required consistency of fluids and liquids provided to the patient",
"definition": "The required consistency (e.g., honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "FluidConsistencyType",
"strength": "example",
"description": "Codes used to represent the consistency of fluids and liquids provided to the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/consistency-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code (Not differentiated from dietTextureModificationType in V3)"
}
]
},
{
"path": "NutritionOrder.oralDiet.instruction",
"short": "Instructions or additional information about the oral diet",
"definition": "Free text or additional instructions or information pertaining to the oral diet.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "NutritionOrder.supplement",
"short": "Supplement components",
"definition": "Oral nutritional products given in order to add further nutritional value to the patient's diet.",
"min": 0,
"max": "*",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"P\""
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=SUPPLEMENT]"
}
]
},
{
"path": "NutritionOrder.supplement.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.supplement.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.supplement.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.supplement.type",
"short": "Type of supplement product requested",
"definition": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SupplementType",
"strength": "example",
"description": "Codes for nutritional supplements to be provided to the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supplement-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code (NutritionalSupplementType)"
}
]
},
{
"path": "NutritionOrder.supplement.productName",
"short": "Product or brand name of the nutritional supplement",
"definition": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.supplement.scheduled",
"short": "Scheduled frequency of supplement",
"definition": "The time period and frequency at which the supplement(s) should be given.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2,TQ1-7/8"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "NutritionOrder.supplement.quantity",
"short": "Amount of the nutritional supplement",
"definition": "The amount of the nutritional supplement to be given.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "NutritionOrder.supplement.instruction",
"short": "Instructions or additional information about the oral supplement",
"definition": "Free text or additional instructions or information pertaining to the oral supplement.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "NutritionOrder.enteralFormula",
"short": "Enteral formula components",
"definition": "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.",
"min": 0,
"max": "1",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value coded for enteral"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=FORMULA]"
}
]
},
{
"path": "NutritionOrder.enteralFormula.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.enteralFormula.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "NutritionOrder.enteralFormula.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.enteralFormula.administrationInstructions",
"short": "Formula feeding instructions expressed as text",
"definition": "Free text formula administration, feeding instructions or additional instructions or information.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SBADM, moodCode=RQO, code=]"
}
]
},
{
"path": "NutritionOrder.enteralFormula.baseFormulaType",
"short": "Type of enteral or infant formula",
"definition": "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EnteralFormulaType",
"strength": "example",
"description": "Codes for type of enteral formula to be administered to patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/entformula-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code (NutritionalFormulaType)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.baseFormulaProductName",
"short": "Product or brand name of the enteral or infant formula",
"definition": "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.enteralFormula.scheduled",
"short": "Scheduled frequency of enteral feeding",
"definition": "The time period and frequency at which the enteral formula should be delivered to the patient.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2,TQ1-7/8"
},
{
"identity": "rim",
"map": ".effectiveUseTime"
}
]
},
{
"path": "NutritionOrder.enteralFormula.additiveType",
"short": "Type of modular component to add to the feeding",
"definition": "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EnteralFormulaAdditiveType",
"strength": "example",
"description": "Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/entformula-additive"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": "N/A (not differentiated from NutritionalFormulaType in V3)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.additiveProductName",
"short": "Product or brand name of the modular additive",
"definition": "The product or brand name of the type of modular component to be added to the formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.enteralFormula.caloricDensity",
"short": "Amount of energy per specified volume that is required",
"definition": "The amount of energy (Calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula the provides 24 Calories per fluid ounce or an adult may require an enteral formula that provides 1.5 Calorie/mL.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".quantity (caloricDensity)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.routeofAdministration",
"short": "How the formula should enter the patient's gastrointestinal tract",
"definition": "The route or physiological path of administration into the patient 's gastrointestinal tract for purposes of providing the formula feeding, e.g., nasogastric tube.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EnteralRouteOfAdministration",
"strength": "required",
"description": "Codes specifying the route of administration of enteral formula.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/enteral-route"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "NutritionOrder.enteralFormula.quantity",
"short": "The volume of formula to provide",
"definition": "The volume of formula to provide to the patient per the specified administration schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "NutritionOrder.enteralFormula.rate",
"short": "Speed with which the formula is provided per period of time",
"definition": "The rate of administration of formula via a feeding pump, e.g., 60 mL per hour, according to the specified schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "NutritionOrder.enteralFormula.rateAdjustment",
"short": "Change in the rate of administration over a given time",
"definition": "The change in the rate of administration over a given time, e.g. increase by 10 mL/hour every 4 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"short": "Upper limit on formula volume per unit of time",
"definition": "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g., 1440 mL over 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
}
]
},
"differential": {
"element": [
{
"path": "NutritionOrder",
"short": "A request for a diet, formula or nutritional supplement",
"definition": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.",
"comments": "Referenced by an Order Request (workflow).",
"alias": [
"Diet Order",
"Diet",
"Nutritional Supplement",
"Enteral Nutrition"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "nor-1",
"name": "nutrition item type",
"severity": "warning",
"human": "Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class",
"xpath": "exists(f:oralDiet) or exists(f:supplement) or exists(f:enteralFormula)"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC / ODS"
},
{
"identity": "rim",
"map": "SupplyRequest"
}
]
},
{
"path": "NutritionOrder.patient",
"short": "The person who requires the diet, formula or nutritional supplement",
"definition": "The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "NutritionOrder.orderer",
"short": "Who ordered the diet, formula or nutritional supplement",
"definition": "The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-12"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "NutritionOrder.identifier",
"short": "Identifiers assigned to this order",
"definition": "Identifiers assigned to this order by the order sender or by the order receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2/ORC-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.encounter",
"short": "The encounter associated with that this nutrition order",
"definition": "An encounter that provides additional information about the healthcare context in which this request is made.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "NutritionOrder.dateTime",
"short": "Date and time the nutrition order was requested",
"definition": "The date and time that this nutrition order was requested.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "NutritionOrder.status",
"short": "proposed | draft | planned | requested | active | on-hold | completed | cancelled",
"definition": "The workflow status of the nutrition order/request.",
"comments": "Typically the system placing the order sets the status to requested. There after, the order is maintained by the receiver that updates the status as the request is handled.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "NutritionOrderStatus",
"strength": "required",
"description": "Codes specifying the state of the request. Describes the lifecycle of the nutrition order.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/nutrition-order-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-1"
},
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"path": "NutritionOrder.allergyIntolerance",
"short": "List of the patient's food and nutrition-related allergies and intolerances",
"definition": "A link to a record of allergies or Intolerances which should be included in the nutrition order.",
"comments": "Information on a patient's food allergies and intolerances, inform healthcare personnel about the type of foods that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "NutritionOrder.foodPreferenceModifier",
"short": "Order-specific modifier about the type of food that should be given",
"definition": "This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comments": "Information on a patient's food preferences inform healthcare personnel about the food that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "PatientDiet",
"strength": "example",
"description": "Medical, cultural or ethical food preferences to help with catering requirements",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/encounter-diet"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"P\",ODS-3"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=NutritionModificationType]"
}
]
},
{
"path": "NutritionOrder.excludeFoodModifier",
"short": "Order-specific modifier about the type of food that should not be given",
"definition": "This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.",
"comments": "Information on a patient's food allergies and intolerances, and preferences inform healthcare personnel about the type of foods that the patient should receive or consume.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "FoodType",
"strength": "example",
"description": "Codes used to indicate the type of food that should NOT be given to the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/food-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.oralDiet",
"short": "Oral diet components",
"definition": "Diet given orally in contrast to enteral (tube) feeding.",
"min": 0,
"max": "1",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"D\""
},
{
"identity": "rim",
"map": "oralDiet .outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=OralDietSupplyType]"
}
]
},
{
"path": "NutritionOrder.oralDiet.type",
"short": "Type of oral diet or diet restrictions that describe what can be consumed orally",
"definition": "The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "OralDiet",
"strength": "example",
"description": "Codes used to indicate the type of diet being ordered for a patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diet-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.scheduled",
"short": "Scheduled frequency of diet",
"definition": "The time period and frequency at which the diet should be given.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2, TQ1-7/8"
},
{
"identity": "rim",
"map": ".expectedUseTime"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient",
"short": "Required nutrient modifications",
"definition": "Class that defines the quantity and type of nutrient modifications required for the oral diet.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.modifier",
"short": "Type of nutrient that is being modified",
"definition": "The nutrient that is being modified such as carbohydrate or sodium.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "NutrientModifier",
"strength": "example",
"description": "Codes for types of nutrient that is being modified such as carbohydrate or sodium.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/nutrient-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.nutrient.amount",
"short": "Quantity of the specified nutrient",
"definition": "The quantity of the specified nutrient to include in diet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture",
"short": "Required texture modifications",
"definition": "Class that describes any texture modifications required for the patient to safely consume various types of solid foods.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".inboundRelationship [typeCode =COMP], target [classCode=PROC, moodCode=EVN, code=DietTextureModificationType]"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.modifier",
"short": "Code to indicate how to alter the texture of the foods, e.g., pureed",
"definition": "Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.",
"comments": "Coupled with the foodType (Meat).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "TextureModifier",
"strength": "example",
"description": "Codes for food consistency types or texture modifications to apply to foods.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/texture-code"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "NutritionOrder.oralDiet.texture.foodType",
"short": "Concepts that are used to identify an entity that is ingested for nutritional purposes",
"definition": "The food type(s) (e.g., meats, all foods) that the texture modification applies to. This could be all foods types.",
"comments": "Coupled with the textureModifier; could be (All Foods).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "TextureModifiedFoodType",
"strength": "example",
"description": "Codes for types of foods that are texture modified.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/modified-foodtype"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code"
}
]
},
{
"path": "NutritionOrder.oralDiet.fluidConsistencyType",
"short": "The required consistency of fluids and liquids provided to the patient",
"definition": "The required consistency (e.g., honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "FluidConsistencyType",
"strength": "example",
"description": "Codes used to represent the consistency of fluids and liquids provided to the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/consistency-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".code (Not differentiated from dietTextureModificationType in V3)"
}
]
},
{
"path": "NutritionOrder.oralDiet.instruction",
"short": "Instructions or additional information about the oral diet",
"definition": "Free text or additional instructions or information pertaining to the oral diet.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "NutritionOrder.supplement",
"short": "Supplement components",
"definition": "Oral nutritional products given in order to add further nutritional value to the patient's diet.",
"min": 0,
"max": "*",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value = \"P\""
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=SUPPLEMENT]"
}
]
},
{
"path": "NutritionOrder.supplement.type",
"short": "Type of supplement product requested",
"definition": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SupplementType",
"strength": "example",
"description": "Codes for nutritional supplements to be provided to the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supplement-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code (NutritionalSupplementType)"
}
]
},
{
"path": "NutritionOrder.supplement.productName",
"short": "Product or brand name of the nutritional supplement",
"definition": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.supplement.scheduled",
"short": "Scheduled frequency of supplement",
"definition": "The time period and frequency at which the supplement(s) should be given.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2,TQ1-7/8"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "NutritionOrder.supplement.quantity",
"short": "Amount of the nutritional supplement",
"definition": "The amount of the nutritional supplement to be given.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "NutritionOrder.supplement.instruction",
"short": "Instructions or additional information about the oral supplement",
"definition": "Free text or additional instructions or information pertaining to the oral supplement.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "NutritionOrder.enteralFormula",
"short": "Enteral formula components",
"definition": "Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.",
"min": 0,
"max": "1",
"condition": [
"nor-1"
],
"mapping": [
{
"identity": "v2",
"map": "ODS-1 Value coded for enteral"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SPLY, moodCode=RQO, code=FORMULA]"
}
]
},
{
"path": "NutritionOrder.enteralFormula.administrationInstructions",
"short": "Formula feeding instructions expressed as text",
"definition": "Free text formula administration, feeding instructions or additional instructions or information.",
"comments": "Free text dosage instructions can be used for cases where the instructions are too complex to code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".outboundRelationship [typeCode =COMP], target [classCode=SBADM, moodCode=RQO, code=]"
}
]
},
{
"path": "NutritionOrder.enteralFormula.baseFormulaType",
"short": "Type of enteral or infant formula",
"definition": "The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "EnteralFormulaType",
"strength": "example",
"description": "Codes for type of enteral formula to be administered to patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/entformula-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": ".participation{typeCode=PRD].role{classCode=MANU), manufacturedFoodKind; .code (NutritionalFormulaType)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.baseFormulaProductName",
"short": "Product or brand name of the enteral or infant formula",
"definition": "The product or brand name of the enteral or infant formula product such as \"ACME Adult Standard Formula\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "NutritionOrder.enteralFormula.scheduled",
"short": "Scheduled frequency of enteral feeding",
"definition": "The time period and frequency at which the enteral formula should be delivered to the patient.",
"alias": [
"frequency"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-2,TQ1-7/8"
},
{
"identity": "rim",
"map": ".effectiveUseTime"
}
]
},
{
"path": "NutritionOrder.enteralFormula.additiveType",
"short": "Type of modular component to add to the feeding",
"definition": "Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EnteralFormulaAdditiveType",
"strength": "example",
"description": "Codes for the type of modular component such as protein, carbohydrate or fiber to be provided in addition to or mixed with the base formula.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/entformula-additive"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-3"
},
{
"identity": "rim",
"map": "N/A (not differentiated from NutritionalFormulaType in V3)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.additiveProductName",
"short": "Product or brand name of the modular additive",
"definition": "The product or brand name of the type of modular component to be added to the formula.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.enteralFormula.caloricDensity",
"short": "Amount of energy per specified volume that is required",
"definition": "The amount of energy (Calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula the provides 24 Calories per fluid ounce or an adult may require an enteral formula that provides 1.5 Calorie/mL.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".quantity (caloricDensity)"
}
]
},
{
"path": "NutritionOrder.enteralFormula.routeofAdministration",
"short": "How the formula should enter the patient's gastrointestinal tract",
"definition": "The route or physiological path of administration into the patient 's gastrointestinal tract for purposes of providing the formula feeding, e.g., nasogastric tube.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "EnteralRouteOfAdministration",
"strength": "required",
"description": "Codes specifying the route of administration of enteral formula.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/enteral-route"
}
},
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"path": "NutritionOrder.enteralFormula.quantity",
"short": "The volume of formula to provide",
"definition": "The volume of formula to provide to the patient per the specified administration schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1-2"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"path": "NutritionOrder.enteralFormula.rate",
"short": "Speed with which the formula is provided per period of time",
"definition": "The rate of administration of formula via a feeding pump, e.g., 60 mL per hour, according to the specified schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"path": "NutritionOrder.enteralFormula.rateAdjustment",
"short": "Change in the rate of administration over a given time",
"definition": "The change in the rate of administration over a given time, e.g. increase by 10 mL/hour every 4 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "NutritionOrder.enteralFormula.maxVolumeToDeliver",
"short": "Upper limit on formula volume per unit of time",
"definition": "The maximum total quantity of formula that may be administered to a subject over the period of time, e.g., 1440 mL over 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "ODS-4"
},
{
"identity": "rim",
"map": ".maxDoseQuantity"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Observation",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Observation",
"name": "Observation",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Observation Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Observation",
"short": "Measurements and simple assertions",
"definition": "Measurements and simple assertions made about a patient, device or other subject.",
"comments": "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as Lab reports, etc.",
"requirements": "Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.",
"alias": [
"Vital Signs",
"Measurement",
"Results",
"Tests"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Observation"
}
],
"constraint": [
{
"key": "obs-6",
"name": "data absent reason",
"severity": "error",
"human": "Shall only be present if Observation.value[x] is not present",
"xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Observation.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Observation.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Observation.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Observation.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Observation.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Observation.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Observation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Observation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Observation.code",
"short": "Type of observation (code / type)",
"definition": "Describes what was observed. Sometimes this is called the observation \"code\".",
"requirements": "Knowing what kind of observation is being made is essential to understanding the observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ObservationType",
"strength": "example",
"description": "Codes identifying types of simple observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3-observation identifier"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Observation.value[x]",
"short": "Actual result",
"definition": "The information determined as a result of making the observation, if the information has a simple value.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/v2/vs/0136> (These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed\"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (The name format is \"'value' + the type name\" with a capital on the first letter of the type).",
"requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
},
{
"code": "CodeableConcept"
},
{
"code": "string"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "SampledData"
},
{
"code": "Attachment"
},
{
"code": "time"
},
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"binding": {
"name": "ObservationValue",
"strength": "example",
"description": "Codes identifying atomic results of observations when value is type codeableConcept",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-values"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX.2, OBX.5, OBX.6"
},
{
"identity": "rim",
"map": "value"
}
]
},
{
"path": "Observation.dataAbsentReason",
"short": "Why the result is missing",
"definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"comments": "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.",
"requirements": "For many results it is necessary to handle exceptional values in measurements.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"obs-6"
],
"binding": {
"name": "ObservationValueAbsentReason",
"strength": "extensible",
"description": "Codes specifying why the result (Observation.value[x]) is missing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-valueabsentreason"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "value.nullFlavor"
}
]
},
{
"path": "Observation.interpretation",
"short": "High, low, normal, etc.",
"definition": "The assessment made based on the result of the observation.",
"requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationInterpretation",
"strength": "extensible",
"description": "Codes identifying interpretations of observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-interpretation"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-8-interpretation codes"
},
{
"identity": "rim",
"map": "interpretationCode"
}
]
},
{
"path": "Observation.comments",
"short": "Comments about result",
"definition": "May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.",
"requirements": "Need to be able to provide free text additional information.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
},
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"path": "Observation.applies[x]",
"short": "Physiologically Relevant time/time-period for observation",
"definition": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"comments": "At least a date should be present unless this observation is a historical report.",
"requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "Observation.issued",
"short": "Date/Time this was made available",
"definition": "The date and time this observation was made available.",
"comments": "Updated when the result is updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: final"
}
],
"path": "Observation.status",
"short": "registered | preliminary | final | amended +",
"definition": "The status of the result value.",
"requirements": "Need to track the status of individual results - some results are finalised before the whole report is finalised.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ObservationStatus",
"strength": "required",
"description": "Codes providing the status of an observation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-11-observation result status"
},
{
"identity": "rim",
"map": "status\n\nAmended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: ok"
}
],
"path": "Observation.reliability",
"short": "ok | ongoing | early | questionable | calibrating | error +",
"definition": "An estimate of the degree to which quality issues have impacted on the value reported.",
"comments": "Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. If the reliability indicator is present, interpreters of a result, whether human or machine, should always either be aware of the status or prevented from using the observation without being unaware that the reliability is not \"ok\".",
"requirements": "Not all results are completely reliable, and some are still reported anyway.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationReliability",
"strength": "required",
"description": "Codes that provide an estimate of the degree to which quality issues have impacted on the value of an observation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-reliability"
}
},
"mapping": [
{
"identity": "v2",
"map": "Maybe OBX.8/OBX.9"
},
{
"identity": "rim",
"map": "uncertaintyCode"
}
]
},
{
"path": "Observation.bodySite[x]",
"short": "Observed body part",
"definition": "Indicates the site on the subject's body where the observation was made ( i.e. the target site).",
"comments": "Only used if not implicit in code found in Observation.code.",
"requirements": "Knowing where the observation is made is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-20-observation site"
},
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "Observation.method",
"short": "How it was done",
"definition": "Indicates the mechanism used to perform the observation.",
"comments": "Only used if not implicit in code for Observation.code.",
"requirements": "In some cases, method can impact results and is thus for determining whether results can be compared or determining significance of results.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationMethod",
"strength": "example",
"description": "Methods for simple observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-methods"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-17-observation method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "Observation.identifier",
"short": "Unique Id for this particular observation",
"definition": "A unique identifier for the simple observation.",
"requirements": "Allows observations to be distinguished and referenced.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX.21"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Observation.subject",
"short": "Who and/or what this is about",
"definition": "The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus,\nother observer (for example a relative or EMT), or any observation made about the subject.",
"comments": "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension (http://hl7.org/fhir/StructureDefinition/indirectTarget) can be used.",
"requirements": "Observations have no value if you don't know who or what they're about.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "Observation.specimen",
"short": "Specimen used for this observation",
"definition": "The specimen that was used when this observation was made.",
"comments": "Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicitly (e.g. Diagnostic Report).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM segment"
},
{
"identity": "rim",
"map": "participation[typeCode=SPC].specimen"
}
]
},
{
"path": "Observation.performer",
"short": "Who did the observation",
"definition": "Who was responsible for asserting the observed value as \"true\".",
"requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / \n(Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"
},
{
"identity": "rim",
"map": "participation[typeCode=PRF]"
}
]
},
{
"path": "Observation.device",
"short": "(Measurement) Device",
"definition": "The device used to generate the observation data.",
"comments": "An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceMetric"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-17 / PRT -10"
},
{
"identity": "rim",
"map": "participation[typeCode=DEV]"
}
]
},
{
"path": "Observation.encounter",
"short": "Healthcare event during which this observation is made",
"definition": "The healthcare event ( e.g. a patient and healthcare provider interaction ) during which this observation is made.",
"requirements": "For some observations it may be important to know the link between an observation and a particular encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Observation.referenceRange",
"short": "Provides guide for interpretation",
"definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comments": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "obs-3",
"name": "reference range",
"severity": "error",
"human": "Must have at least a low or a high or text",
"xpath": "(exists(f:low) or exists(f:high)or exists(f:text))"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX.7"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Observation.referenceRange.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Observation.referenceRange.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Observation.referenceRange.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Observation.referenceRange.low",
"short": "Low Range, if relevant",
"definition": "The value of the low bound of the reference range. If this element is omitted, the low bound of the reference range is assumed to be meaningless. (e.g. reference range is <2.3) If the low.comparator element is missing, it is assumed to be '>'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"obs-3",
"obs-4"
],
"constraint": [
{
"key": "obs-4",
"name": "low range comparators",
"severity": "error",
"human": "Low range comparators can only be '>' or '>=' or empty",
"xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<=')"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:IVL_PQ.low"
}
]
},
{
"path": "Observation.referenceRange.high",
"short": "High Range, if relevant",
"definition": "The value of the high bound of the reference range. If this element is omitted, the high bound of the reference range is assumed to be meaningless. (e.g. reference range is > 5) If the low.comparator element is missing , it is assumed to be '<'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"obs-3",
"obs-5"
],
"constraint": [
{
"key": "obs-5",
"name": "high range comparators",
"severity": "error",
"human": "High range comparators can only be '<' or '<=' or empty",
"xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>=')"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:IVL_PQ.high"
}
]
},
{
"path": "Observation.referenceRange.meaning",
"short": "Indicates the meaning/use of this range of this range",
"definition": "Code for the meaning of the reference range.",
"comments": "This SHOULD be populated if there is more than one range.",
"requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationRangeMeaning",
"strength": "example",
"description": "Code for the meaning of a reference range",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referencerange-meaning"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-10-nature of abnormal test?"
},
{
"identity": "rim",
"map": "interpretationCode"
}
]
},
{
"path": "Observation.referenceRange.age",
"short": "Applicable age range, if relevant",
"definition": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"requirements": "Some analytes vary greatly over age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}
]
},
{
"path": "Observation.referenceRange.text",
"short": "Text based reference range in an observation",
"definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of 'normals'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:ST"
}
]
},
{
"path": "Observation.related",
"short": "Observations related to this observation",
"definition": "Related observations - either components, or previous observations, or statements of derivation.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).",
"requirements": "Some observations have important relationships to other observations (e.g Blood Pressure = systolic + diastolic), or are derived from other observations (e.g. calculated apgar score).",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "Relationships established by OBX-4 usage"
},
{
"identity": "rim",
"map": "outBoundRelationship"
}
]
},
{
"path": "Observation.related.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Observation.related.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Observation.related.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Observation.related.type",
"short": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"definition": "A code specifying the kind of relationship that exists with the target observation.",
"comments": "A relationship type SHOULD be provided. If the relationship type is \"COMP\" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.",
"requirements": "May need to indicate whether this observation is composed of others, or merely derived from them.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ObservationRelationshipType",
"strength": "required",
"description": "Codes specifying how two observations are related",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-relationshiptypes"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Observation.related.target",
"short": "Observation that is related to this one",
"definition": "A reference to the observation that is related to this observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "rim",
"map": ".targetObservation"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Observation",
"short": "Measurements and simple assertions",
"definition": "Measurements and simple assertions made about a patient, device or other subject.",
"comments": "Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as Lab reports, etc.",
"requirements": "Observations are a key aspect of healthcare. This resource is used to capture those that do not require more sophisticated mechanisms.",
"alias": [
"Vital Signs",
"Measurement",
"Results",
"Tests"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "obs-6",
"name": "data absent reason",
"severity": "error",
"human": "Shall only be present if Observation.value[x] is not present",
"xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Observation.code",
"short": "Type of observation (code / type)",
"definition": "Describes what was observed. Sometimes this is called the observation \"code\".",
"requirements": "Knowing what kind of observation is being made is essential to understanding the observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ObservationType",
"strength": "example",
"description": "Codes identifying types of simple observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-3-observation identifier"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Observation.value[x]",
"short": "Actual result",
"definition": "The information determined as a result of making the observation, if the information has a simple value.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For boolean values use valueCodeableConcept and select codes from <http://hl7.org/fhir/v2/vs/0136> (These \"yes/no\" concepts can be mapped to the display name \"true/false\" or other mutually exclusive terms that may be needed\"). The element, Observation.value[x], has a variable name depending on the type as follows: valueQuantity, valueCodeableConcept, valueRatio, valueChoice, valuePeriod, valueSampleData, or valueString (The name format is \"'value' + the type name\" with a capital on the first letter of the type).",
"requirements": "An observation exists to have a value, though it may not if it is in error, or it represents a group of observations.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
},
{
"code": "CodeableConcept"
},
{
"code": "string"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "SampledData"
},
{
"code": "Attachment"
},
{
"code": "time"
},
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"binding": {
"name": "ObservationValue",
"strength": "example",
"description": "Codes identifying atomic results of observations when value is type codeableConcept",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-values"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX.2, OBX.5, OBX.6"
},
{
"identity": "rim",
"map": "value"
}
]
},
{
"path": "Observation.dataAbsentReason",
"short": "Why the result is missing",
"definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.",
"comments": "\"Null\" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be \"detected\", \"not detected\", \"inconclusive\", or \"test not done\". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values.",
"requirements": "For many results it is necessary to handle exceptional values in measurements.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"obs-6"
],
"binding": {
"name": "ObservationValueAbsentReason",
"strength": "extensible",
"description": "Codes specifying why the result (Observation.value[x]) is missing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-valueabsentreason"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "value.nullFlavor"
}
]
},
{
"path": "Observation.interpretation",
"short": "High, low, normal, etc.",
"definition": "The assessment made based on the result of the observation.",
"requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationInterpretation",
"strength": "extensible",
"description": "Codes identifying interpretations of observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-interpretation"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-8-interpretation codes"
},
{
"identity": "rim",
"map": "interpretationCode"
}
]
},
{
"path": "Observation.comments",
"short": "Comments about result",
"definition": "May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.",
"requirements": "Need to be able to provide free text additional information.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
},
{
"identity": "rim",
"map": "subjectOf.observationEvent[code=\"annotation\"].value"
}
]
},
{
"path": "Observation.applies[x]",
"short": "Physiologically Relevant time/time-period for observation",
"definition": "The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the \"physiologically relevant time\". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.",
"comments": "At least a date should be present unless this observation is a historical report.",
"requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX-14-date/time of the observation, and/or OBX-19 after v2.4 (depends on who observation made)"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"path": "Observation.issued",
"short": "Date/Time this was made available",
"definition": "The date and time this observation was made available.",
"comments": "Updated when the result is updated.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"
},
{
"identity": "rim",
"map": "participation[typeCode=AUT].time"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: final"
}
],
"path": "Observation.status",
"short": "registered | preliminary | final | amended +",
"definition": "The status of the result value.",
"requirements": "Need to track the status of individual results - some results are finalised before the whole report is finalised.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ObservationStatus",
"strength": "required",
"description": "Codes providing the status of an observation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-11-observation result status"
},
{
"identity": "rim",
"map": "status\n\nAmended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "default: ok"
}
],
"path": "Observation.reliability",
"short": "ok | ongoing | early | questionable | calibrating | error +",
"definition": "An estimate of the degree to which quality issues have impacted on the value reported.",
"comments": "Note that in most contexts, unreliable results are not recorded, deleted, or otherwise excluded, but it's not always possible to exclude them from the record. If the reliability indicator is present, interpreters of a result, whether human or machine, should always either be aware of the status or prevented from using the observation without being unaware that the reliability is not \"ok\".",
"requirements": "Not all results are completely reliable, and some are still reported anyway.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ObservationReliability",
"strength": "required",
"description": "Codes that provide an estimate of the degree to which quality issues have impacted on the value of an observation",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-reliability"
}
},
"mapping": [
{
"identity": "v2",
"map": "Maybe OBX.8/OBX.9"
},
{
"identity": "rim",
"map": "uncertaintyCode"
}
]
},
{
"path": "Observation.bodySite[x]",
"short": "Observed body part",
"definition": "Indicates the site on the subject's body where the observation was made ( i.e. the target site).",
"comments": "Only used if not implicit in code found in Observation.code.",
"requirements": "Knowing where the observation is made is important for tracking if multiple sites are possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-20-observation site"
},
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "Observation.method",
"short": "How it was done",
"definition": "Indicates the mechanism used to perform the observation.",
"comments": "Only used if not implicit in code for Observation.code.",
"requirements": "In some cases, method can impact results and is thus for determining whether results can be compared or determining significance of results.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationMethod",
"strength": "example",
"description": "Methods for simple observations",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-methods"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-17-observation method"
},
{
"identity": "rim",
"map": "methodCode"
}
]
},
{
"path": "Observation.identifier",
"short": "Unique Id for this particular observation",
"definition": "A unique identifier for the simple observation.",
"requirements": "Allows observations to be distinguished and referenced.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX.21"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Observation.subject",
"short": "Who and/or what this is about",
"definition": "The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus,\nother observer (for example a relative or EMT), or any observation made about the subject.",
"comments": "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. If the target of the observation is different than the subject, the general extension (http://hl7.org/fhir/StructureDefinition/indirectTarget) can be used.",
"requirements": "Observations have no value if you don't know who or what they're about.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": "participation[typeCode=SBJ]"
}
]
},
{
"path": "Observation.specimen",
"short": "Specimen used for this observation",
"definition": "The specimen that was used when this observation was made.",
"comments": "Observations are not made on specimens themselves; they are made on a subject, but usually by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources are often used in contexts that track the specimen explicitly (e.g. Diagnostic Report).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM segment"
},
{
"identity": "rim",
"map": "participation[typeCode=SPC].specimen"
}
]
},
{
"path": "Observation.performer",
"short": "Who did the observation",
"definition": "Who was responsible for asserting the observed value as \"true\".",
"requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OBX.15 / (Practitioner) OBX-16-responsible observer, PRT-5-participation person:PRT-4-participation='RO' / \n(Device) OBX-18-equipment instance identifier , PRT-10-participation device:PRT-4-participation='EQUIP' / (Organization) OBX-23-performing organization name, PRT-8-participation organization:PRT-4-participation='PO'"
},
{
"identity": "rim",
"map": "participation[typeCode=PRF]"
}
]
},
{
"path": "Observation.device",
"short": "(Measurement) Device",
"definition": "The device used to generate the observation data.",
"comments": "An extension should be used if further typing of the device is needed. Devices used to support obtaining an observation can be represented using either extension or through the Observation.related element.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceMetric"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-17 / PRT -10"
},
{
"identity": "rim",
"map": "participation[typeCode=DEV]"
}
]
},
{
"path": "Observation.encounter",
"short": "Healthcare event during which this observation is made",
"definition": "The healthcare event ( e.g. a patient and healthcare provider interaction ) during which this observation is made.",
"requirements": "For some observations it may be important to know the link between an observation and a particular encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1"
},
{
"identity": "rim",
"map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Observation.referenceRange",
"short": "Provides guide for interpretation",
"definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.",
"comments": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g. specific to the patient's age, gender, weight and other factors), but this may not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.",
"requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "obs-3",
"name": "reference range",
"severity": "error",
"human": "Must have at least a low or a high or text",
"xpath": "(exists(f:low) or exists(f:high)or exists(f:text))"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX.7"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Observation.referenceRange.low",
"short": "Low Range, if relevant",
"definition": "The value of the low bound of the reference range. If this element is omitted, the low bound of the reference range is assumed to be meaningless. (e.g. reference range is <2.3) If the low.comparator element is missing, it is assumed to be '>'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"obs-3",
"obs-4"
],
"constraint": [
{
"key": "obs-4",
"name": "low range comparators",
"severity": "error",
"human": "Low range comparators can only be '>' or '>=' or empty",
"xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<=')"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:IVL_PQ.low"
}
]
},
{
"path": "Observation.referenceRange.high",
"short": "High Range, if relevant",
"definition": "The value of the high bound of the reference range. If this element is omitted, the high bound of the reference range is assumed to be meaningless. (e.g. reference range is > 5) If the low.comparator element is missing , it is assumed to be '<'.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"condition": [
"obs-3",
"obs-5"
],
"constraint": [
{
"key": "obs-5",
"name": "high range comparators",
"severity": "error",
"human": "High range comparators can only be '<' or '<=' or empty",
"xpath": "not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>=')"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:IVL_PQ.high"
}
]
},
{
"path": "Observation.referenceRange.meaning",
"short": "Indicates the meaning/use of this range of this range",
"definition": "Code for the meaning of the reference range.",
"comments": "This SHOULD be populated if there is more than one range.",
"requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. age, hormonal cycles, etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ObservationRangeMeaning",
"strength": "example",
"description": "Code for the meaning of a reference range",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referencerange-meaning"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBX-10-nature of abnormal test?"
},
{
"identity": "rim",
"map": "interpretationCode"
}
]
},
{
"path": "Observation.referenceRange.age",
"short": "Applicable age range, if relevant",
"definition": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.",
"requirements": "Some analytes vary greatly over age.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"
}
]
},
{
"path": "Observation.referenceRange.text",
"short": "Text based reference range in an observation",
"definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of \"Negative\" or a list or table of 'normals'.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-7-references range"
},
{
"identity": "rim",
"map": "value:ST"
}
]
},
{
"path": "Observation.related",
"short": "Observations related to this observation",
"definition": "Related observations - either components, or previous observations, or statements of derivation.",
"comments": "Normally, an observation will have either a value or a set of related observations. A few observations (e.g. apgar store) may have both a value and related observations (for apgar, the observations from which the measure is derived).",
"requirements": "Some observations have important relationships to other observations (e.g Blood Pressure = systolic + diastolic), or are derived from other observations (e.g. calculated apgar score).",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "Relationships established by OBX-4 usage"
},
{
"identity": "rim",
"map": "outBoundRelationship"
}
]
},
{
"path": "Observation.related.type",
"short": "has-component | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by",
"definition": "A code specifying the kind of relationship that exists with the target observation.",
"comments": "A relationship type SHOULD be provided. If the relationship type is \"COMP\" (composed), then the observation should not be displayed/interpreted in the absence of the related observations.",
"requirements": "May need to indicate whether this observation is composed of others, or merely derived from them.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ObservationRelationshipType",
"strength": "required",
"description": "Codes specifying how two observations are related",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-relationshiptypes"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": ".typeCode"
}
]
},
{
"path": "Observation.related.target",
"short": "Observation that is related to this one",
"definition": "A reference to the observation that is related to this observation.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "rim",
"map": ".targetObservation"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "OperationDefinition",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"name": "OperationDefinition",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for OperationDefinition Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "OperationDefinition",
"short": "Definition of an operation or a named query",
"definition": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min": 1,
"max": "1",
"type": [
{
"code": "OperationDefinition"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "OperationDefinition.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "OperationDefinition.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "OperationDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "OperationDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "OperationDefinition.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.url",
"short": "Logical url to reference this operation definition",
"definition": "An absolute url that is used to identify this operation definition when it is referenced in a specification, model, design or an instance (should be globally unique uri).",
"comments": "Can be a urn:uuid: or a urn:oid:.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "OperationDefinition.version",
"short": "Logical id for this version of the operation definition",
"definition": "The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"requirements": "There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.name",
"short": "Informal name for this profile",
"definition": "A free text natural language name identifying the Profile.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the operation definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "OperationDefinition.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the operation definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.description",
"short": "Natural language description of the operation",
"definition": "A free text natural language description of the profile and its use.",
"comments": "This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.requirements",
"short": "Why is this needed?",
"definition": "Explains why this operation definition is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the profile.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "OperationDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.date",
"short": "Date for this version of the operation definition",
"definition": "The date that this version of the profile was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is operation or named query.",
"comments": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationKind",
"strength": "required",
"description": "Whether an operation is a normal operation or a query",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-kind"
}
}
},
{
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.notes",
"short": "Additional information about use",
"definition": "Additional information about how to use this operation or named query.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.base",
"short": "Marks this as a profile of the base",
"definition": "Indicates that this operation definition is a constraining profile on the base.",
"comments": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
},
{
"path": "OperationDefinition.system",
"short": "Invoke at the system level?",
"definition": "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.type",
"short": "Invoke at resource level for these type",
"definition": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "OperationDefinition.instance",
"short": "Invoke on an instance?",
"definition": "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "opd-1",
"name": "Tuple Parameteter",
"severity": "error",
"human": "Either a type must be provided, or parts",
"xpath": "exists(f:type) or exists(f:part)"
}
]
},
{
"path": "OperationDefinition.parameter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.parameter.name",
"short": "Name of the parameter",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comments": "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationParameterUse",
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-parameter-use"
}
}
},
{
"path": "OperationDefinition.parameter.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter hs",
"definition": "The type for this parameter.",
"comments": "if there is no stated parameter, then the parameter is a \"Tuple\" type and must have at least one part defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"binding": {
"name": "OperationParameterType",
"strength": "required",
"description": "The type of a parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-definition-parameter-type"
}
}
},
{
"path": "OperationDefinition.parameter.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "OperationDefinition.parameter.part",
"short": "Parts of a Tuple Parameter",
"definition": "The parts of a Tuple Parameter.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"condition": [
"opd-1"
]
},
{
"path": "OperationDefinition.parameter.part.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.part.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.parameter.part.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationDefinition.parameter.part.name",
"short": "Name of the parameter",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.part.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.part.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.part.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.part.type",
"short": "What type this parameter hs",
"definition": "The type for this parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationParameterType",
"strength": "required",
"description": "The type of a parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-definition-parameter-type"
}
}
},
{
"path": "OperationDefinition.parameter.part.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
}
]
},
"differential": {
"element": [
{
"path": "OperationDefinition",
"short": "Definition of an operation or a named query",
"definition": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationDefinition.url",
"short": "Logical url to reference this operation definition",
"definition": "An absolute url that is used to identify this operation definition when it is referenced in a specification, model, design or an instance (should be globally unique uri).",
"comments": "Can be a urn:uuid: or a urn:oid:.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "OperationDefinition.version",
"short": "Logical id for this version of the operation definition",
"definition": "The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"requirements": "There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.name",
"short": "Informal name for this profile",
"definition": "A free text natural language name identifying the Profile.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the operation definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the operation definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "OperationDefinition.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the operation definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "OperationDefinition.description",
"short": "Natural language description of the operation",
"definition": "A free text natural language description of the profile and its use.",
"comments": "This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.requirements",
"short": "Why is this needed?",
"definition": "Explains why this operation definition is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the profile.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "OperationDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of profiles that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.date",
"short": "Date for this version of the operation definition",
"definition": "The date that this version of the profile was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "OperationDefinition.kind",
"short": "operation | query",
"definition": "Whether this is operation or named query.",
"comments": "Named queries are invoked differently, and have different capabilities.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationKind",
"strength": "required",
"description": "Whether an operation is a normal operation or a query",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-kind"
}
}
},
{
"path": "OperationDefinition.code",
"short": "Name used to invoke the operation",
"definition": "The name used to invoke the operation.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.notes",
"short": "Additional information about use",
"definition": "Additional information about how to use this operation or named query.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.base",
"short": "Marks this as a profile of the base",
"definition": "Indicates that this operation definition is a constraining profile on the base.",
"comments": "A constrained profile can make optional parameters required or not used and clarify documentation.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition"
}
]
},
{
"path": "OperationDefinition.system",
"short": "Invoke at the system level?",
"definition": "Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.type",
"short": "Invoke at resource level for these type",
"definition": "Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "OperationDefinition.instance",
"short": "Invoke on an instance?",
"definition": "Indicates whether this operation can be invoked on a particular instance of one of the given types.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "OperationDefinition.parameter",
"short": "Parameters for the operation/query",
"definition": "The parameters for the operation/query.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "opd-1",
"name": "Tuple Parameteter",
"severity": "error",
"human": "Either a type must be provided, or parts",
"xpath": "exists(f:type) or exists(f:part)"
}
]
},
{
"path": "OperationDefinition.parameter.name",
"short": "Name of the parameter",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.use",
"short": "in | out",
"definition": "Whether this is an input or an output parameter.",
"comments": "If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationParameterUse",
"strength": "required",
"description": "Whether an operation parameter is an input or an output parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-parameter-use"
}
}
},
{
"path": "OperationDefinition.parameter.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.type",
"short": "What type this parameter hs",
"definition": "The type for this parameter.",
"comments": "if there is no stated parameter, then the parameter is a \"Tuple\" type and must have at least one part defined.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"opd-1"
],
"binding": {
"name": "OperationParameterType",
"strength": "required",
"description": "The type of a parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-definition-parameter-type"
}
}
},
{
"path": "OperationDefinition.parameter.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"path": "OperationDefinition.parameter.part",
"short": "Parts of a Tuple Parameter",
"definition": "The parts of a Tuple Parameter.",
"comments": "Query Definitions only have one output parameter, named \"result\". This may not be described, but can be to allow a profile to be defined.",
"min": 0,
"max": "*",
"condition": [
"opd-1"
]
},
{
"path": "OperationDefinition.parameter.part.name",
"short": "Name of the parameter",
"definition": "The name of used to identify the parameter.",
"comments": "This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "OperationDefinition.parameter.part.min",
"short": "Minimum Cardinality",
"definition": "The minimum number of times this parameter SHALL appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "OperationDefinition.parameter.part.max",
"short": "Maximum Cardinality (a number or *)",
"definition": "The maximum number of times this element is permitted to appear in the request or response.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.part.documentation",
"short": "Description of meaning/use",
"definition": "Describes the meaning or use of this parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "OperationDefinition.parameter.part.type",
"short": "What type this parameter hs",
"definition": "The type for this parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "OperationParameterType",
"strength": "required",
"description": "The type of a parameter",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/operation-definition-parameter-type"
}
}
},
{
"path": "OperationDefinition.parameter.part.profile",
"short": "Profile on the type",
"definition": "A profile the specifies the rules that this parameter must conform to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "OperationOutcome",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/OperationOutcome",
"name": "OperationOutcome",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for OperationOutcome Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "OperationOutcome",
"short": "Information about the success/failure of an action",
"definition": "A collection of error, warning or information messages that result from a system action.",
"comments": "Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.",
"min": 1,
"max": "1",
"type": [
{
"code": "OperationOutcome"
}
],
"mapping": [
{
"identity": "rim",
"map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}
]
},
{
"path": "OperationOutcome.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "OperationOutcome.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "OperationOutcome.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "OperationOutcome.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "OperationOutcome.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "OperationOutcome.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationOutcome.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationOutcome.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationOutcome.issue",
"short": "A single issue associated with the action",
"definition": "An error, warning or information message that results from a system action.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ERR"
},
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "OperationOutcome.issue.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationOutcome.issue.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "OperationOutcome.issue.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OperationOutcome.issue.severity",
"short": "fatal | error | warning | information",
"definition": "Indicates whether the issue indicates a variation from successful processing.",
"comments": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
"requirements": "Indicates how relevant the issue is to the overall success of the action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "IssueSeverity",
"strength": "required",
"description": "How the issue affects the success of the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/issue-severity"
}
},
"mapping": [
{
"identity": "v2",
"map": "ERR-4"
},
{
"identity": "rim",
"map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
}
]
},
{
"path": "OperationOutcome.issue.code",
"short": "Error or warning code",
"definition": "Describes the type of the issue.",
"requirements": "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide it's own codes in other coding elements in the type. A human readable description of the type of the issue SHOULD be placed in code.text.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "IssueType",
"strength": "required",
"description": "A coded expression of the type of issue",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/issue-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ERR-3, ERR-5"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "OperationOutcome.issue.details",
"short": "Additional diagnostic information about the issue",
"definition": "Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stck dump to help trace the issue.",
"comments": "typically this field is used to provide troubleshooting information about the error.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR-8"
},
{
"identity": "rim",
"map": "./text[parent::AcknowledgmentDetail]"
}
]
},
{
"path": "OperationOutcome.issue.location",
"short": "XPath of element(s) related to issue",
"definition": "A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.",
"comments": "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON.",
"requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR-2"
},
{
"identity": "rim",
"map": "./location[parent::AcknowledgmentDetail]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "OperationOutcome",
"short": "Information about the success/failure of an action",
"definition": "A collection of error, warning or information messages that result from a system action.",
"comments": "Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Grouping is handled through multiple repetitions from whatever context references the outcomes (no specific grouper required)"
}
]
},
{
"path": "OperationOutcome.issue",
"short": "A single issue associated with the action",
"definition": "An error, warning or information message that results from a system action.",
"min": 1,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "ERR"
},
{
"identity": "rim",
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
]
},
{
"path": "OperationOutcome.issue.severity",
"short": "fatal | error | warning | information",
"definition": "Indicates whether the issue indicates a variation from successful processing.",
"comments": "This is labeled as \"Is Modifier\" because applications should not confuse hints and warnings with errors.",
"requirements": "Indicates how relevant the issue is to the overall success of the action.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "IssueSeverity",
"strength": "required",
"description": "How the issue affects the success of the action",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/issue-severity"
}
},
"mapping": [
{
"identity": "v2",
"map": "ERR-4"
},
{
"identity": "rim",
"map": "./typeCode[parent::AcknowledgmentDetail] or unique(./inboundRelationship[parent::Observation and typeCode='SUBJ' and isNormalActRelationship()]/source[classCode=\"OBS\" and moodCode=\"EVN\" and implies(code, ActCode#SEV and isNormalAct())/value[xsi:type=\"CD\"]"
}
]
},
{
"path": "OperationOutcome.issue.code",
"short": "Error or warning code",
"definition": "Describes the type of the issue.",
"requirements": "Expresses the issue in a human and computer-friendly way, allowing the requesting system to behave differently based on the type of issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide it's own codes in other coding elements in the type. A human readable description of the type of the issue SHOULD be placed in code.text.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "IssueType",
"strength": "required",
"description": "A coded expression of the type of issue",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/issue-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "ERR-3, ERR-5"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "OperationOutcome.issue.details",
"short": "Additional diagnostic information about the issue",
"definition": "Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stck dump to help trace the issue.",
"comments": "typically this field is used to provide troubleshooting information about the error.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR-8"
},
{
"identity": "rim",
"map": "./text[parent::AcknowledgmentDetail]"
}
]
},
{
"path": "OperationOutcome.issue.location",
"short": "XPath of element(s) related to issue",
"definition": "A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.",
"comments": "The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON.",
"requirements": "Allows systems to highlight or otherwise guide users to elements implicated in issues to allow them to be fixed more easily.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ERR-2"
},
{
"identity": "rim",
"map": "./location[parent::AcknowledgmentDetail]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Order",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Order",
"name": "Order",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Order Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Order",
"short": "A request to perform an action",
"definition": "A request to perform an action.",
"alias": [
"Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Order"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=RQO]"
}
]
},
{
"path": "Order.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Order.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Order.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Order.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Order.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Order.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Order.date",
"short": "When the order was made",
"definition": "When the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Order.subject",
"short": "Patient this order is about",
"definition": "Patient this order is about.",
"comments": "May be left blank if the request reference identifies the patient, or if the request is not associated with a patient.",
"alias": [
"Patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Order.source",
"short": "Who initiated the order",
"definition": "Who initiated the order.",
"alias": [
"Author",
"Practitioner"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Order.target",
"short": "Who is intended to fulfill the order",
"definition": "Who is intended to fulfill the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "Unclear: MSH-5 / IPC-7 / BPO-8 / RXO-32 / RXE-40 / RXD-30 / RXG-11 / RXG-27 / PRT-8 (PRT-4-participation in { 'AP', 'DP', 'PO', 'RT' })"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Order.reason[x]",
"short": "Text - why the order was made",
"definition": "Text - why the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16.2 / OBR-31.2 / BPO-13.2-BP / RXO-20.2 / RXE-27.2 / RXD-21.2 / RXG-22.2 / RXA-19.2"
},
{
"identity": "rim",
"map": ".reasonCode or .outboundRelationship[typeCode=RSON].target"
}
]
},
{
"path": "Order.authority",
"short": "If required by policy",
"definition": "If required by policy.",
"comments": "Reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "if ordering provider, then ORC-12, OBR-16, etc."
},
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role"
}
]
},
{
"path": "Order.when",
"short": "When order should be fulfilled",
"definition": "When order should be fulfilled.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "ord-1",
"name": "Scheduling Details",
"severity": "error",
"human": "Provide a code or a schedule, but not both",
"xpath": "exists(f:code) != exists(f:schedule)"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1, TQ2"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Order.when.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Order.when.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Order.when.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Order.when.code",
"short": "Code specifies when request should be done. The code may simply be a priority code",
"definition": "Code specifies when request should be done. The code may simply be a priority code.",
"comments": "This is usually a local code agreed in the context of the ordering workflow.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ord-1"
],
"binding": {
"name": "RequestedTime",
"strength": "required",
"description": "When a requested action should be performed (e.g. STAT, daily, evenings, etc.)"
},
"mapping": [
{
"identity": "rim",
"map": "GTS is a coded value"
}
]
},
{
"path": "Order.when.schedule",
"short": "A formal schedule",
"definition": "A formal schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"condition": [
"ord-1"
],
"mapping": [
{
"identity": "rim",
"map": "GTS is a complex schedule"
}
]
},
{
"path": "Order.detail",
"short": "What action is being ordered",
"definition": "What action is being ordered.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Order",
"short": "A request to perform an action",
"definition": "A request to perform an action.",
"alias": [
"Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=RQO]"
}
]
},
{
"path": "Order.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order by the orderer or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Order.date",
"short": "When the order was made",
"definition": "When the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Order.subject",
"short": "Patient this order is about",
"definition": "Patient this order is about.",
"comments": "May be left blank if the request reference identifies the patient, or if the request is not associated with a patient.",
"alias": [
"Patient"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
}
]
},
{
"path": "Order.source",
"short": "Who initiated the order",
"definition": "Who initiated the order.",
"alias": [
"Author",
"Practitioner"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Order.target",
"short": "Who is intended to fulfill the order",
"definition": "Who is intended to fulfill the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "Unclear: MSH-5 / IPC-7 / BPO-8 / RXO-32 / RXE-40 / RXD-30 / RXG-11 / RXG-27 / PRT-8 (PRT-4-participation in { 'AP', 'DP', 'PO', 'RT' })"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Order.reason[x]",
"short": "Text - why the order was made",
"definition": "Text - why the order was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16.2 / OBR-31.2 / BPO-13.2-BP / RXO-20.2 / RXE-27.2 / RXD-21.2 / RXG-22.2 / RXA-19.2"
},
{
"identity": "rim",
"map": ".reasonCode or .outboundRelationship[typeCode=RSON].target"
}
]
},
{
"path": "Order.authority",
"short": "If required by policy",
"definition": "If required by policy.",
"comments": "Reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "if ordering provider, then ORC-12, OBR-16, etc."
},
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role"
}
]
},
{
"path": "Order.when",
"short": "When order should be fulfilled",
"definition": "When order should be fulfilled.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "ord-1",
"name": "Scheduling Details",
"severity": "error",
"human": "Provide a code or a schedule, but not both",
"xpath": "exists(f:code) != exists(f:schedule)"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1, TQ2"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Order.when.code",
"short": "Code specifies when request should be done. The code may simply be a priority code",
"definition": "Code specifies when request should be done. The code may simply be a priority code.",
"comments": "This is usually a local code agreed in the context of the ordering workflow.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"ord-1"
],
"binding": {
"name": "RequestedTime",
"strength": "required",
"description": "When a requested action should be performed (e.g. STAT, daily, evenings, etc.)"
},
"mapping": [
{
"identity": "rim",
"map": "GTS is a coded value"
}
]
},
{
"path": "Order.when.schedule",
"short": "A formal schedule",
"definition": "A formal schedule.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"condition": [
"ord-1"
],
"mapping": [
{
"identity": "rim",
"map": "GTS is a complex schedule"
}
]
},
{
"path": "Order.detail",
"short": "What action is being ordered",
"definition": "What action is being ordered.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "OrderResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/OrderResponse",
"name": "OrderResponse",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for OrderResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "OrderResponse",
"short": "A response to an order",
"definition": "A response to an order.",
"comments": "There might be more than one response to an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "OrderResponse"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=EVN]"
}
]
},
{
"path": "OrderResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "OrderResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "OrderResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "OrderResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "OrderResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "OrderResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OrderResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OrderResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "OrderResponse.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "OrderResponse.request",
"short": "The order that this is a response to",
"definition": "A reference to the order that this is in response to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Order"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2 / ORC-3, or OBR-2 | OBR-3"
},
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=FLFS].target"
}
]
},
{
"path": "OrderResponse.date",
"short": "When the response was made",
"definition": "The date and time at which this order response was made (created/posted).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "OrderResponse.who",
"short": "Who made the response",
"definition": "The person, organization, or device credited with making the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "Practitioner: ORC-19 | PRT / Organization: PRT"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "OrderResponse.authority[x]",
"short": "If required by policy",
"definition": "A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.",
"comments": "Reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "Defined in FHIR as 'if required by policy'; unclear how this would map to V2 except ORC-19.9-action by.assigning authority or ORC-30-enterer authorization mode, neither of which exactly scales to a resource"
},
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN].code\n\nor\n\n.outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN]"
}
]
},
{
"path": "OrderResponse.orderStatus",
"short": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed",
"definition": "What this response says about the status of the original order.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "OrderStatus",
"strength": "required",
"description": "The status of the response to an order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/order-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-1 + ORC-5"
},
{
"identity": "rim",
"map": ".code (different trigger events for different outcomes)"
}
]
},
{
"path": "OrderResponse.description",
"short": "Additional description of the response",
"definition": "Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16.2-order control code reason.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "OrderResponse.fulfillment",
"short": "Details of the outcome of performing the order",
"definition": "Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ]/target[moodCode=RQO]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "OrderResponse",
"short": "A response to an order",
"definition": "A response to an order.",
"comments": "There might be more than one response to an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[classCode=ACTN, moodCode=EVN]"
}
]
},
{
"path": "OrderResponse.identifier",
"short": "Identifiers assigned to this order by the orderer or by the receiver",
"definition": "Identifiers assigned to this order. The identifiers are usually assigned by the system responding to the order, but they may be provided or added to by other systems.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "OrderResponse.request",
"short": "The order that this is a response to",
"definition": "A reference to the order that this is in response to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Order"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2 / ORC-3, or OBR-2 | OBR-3"
},
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=FLFS].target"
}
]
},
{
"path": "OrderResponse.date",
"short": "When the response was made",
"definition": "The date and time at which this order response was made (created/posted).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "OrderResponse.who",
"short": "Who made the response",
"definition": "The person, organization, or device credited with making the response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "Practitioner: ORC-19 | PRT / Organization: PRT"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "OrderResponse.authority[x]",
"short": "If required by policy",
"definition": "A reference to an authority policy that is the reason for the response. Usually this is used when the order is rejected, to provide a reason for rejection.",
"comments": "Reference will be constrained when suitable targets exist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "Defined in FHIR as 'if required by policy'; unclear how this would map to V2 except ORC-19.9-action by.assigning authority or ORC-30-enterer authorization mode, neither of which exactly scales to a resource"
},
{
"identity": "rim",
"map": ".outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN].code\n\nor\n\n.outboundRelationships[typeCode=COVBY].target[classCode=POLICY, moodCode=EVN]"
}
]
},
{
"path": "OrderResponse.orderStatus",
"short": "pending | review | rejected | error | accepted | cancelled | replaced | aborted | completed",
"definition": "What this response says about the status of the original order.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "OrderStatus",
"strength": "required",
"description": "The status of the response to an order",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/order-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-1 + ORC-5"
},
{
"identity": "rim",
"map": ".code (different trigger events for different outcomes)"
}
]
},
{
"path": "OrderResponse.description",
"short": "Additional description of the response",
"definition": "Additional description about the response - e.g. a text description provided by a human user when making decisions about the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16.2-order control code reason.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "OrderResponse.fulfillment",
"short": "Details of the outcome of performing the order",
"definition": "Links to resources that provide details of the outcome of performing the order. E.g. Diagnostic Reports in a response that is made to an order that referenced a diagnostic order.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ]/target[moodCode=RQO]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Organization",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Organization",
"name": "Organization",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Organization Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Organization",
"short": "A grouping of people or organizations with a common purpose",
"definition": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Organization"
}
],
"constraint": [
{
"key": "org-1",
"name": "AtLeastANameOrId",
"severity": "error",
"human": "The organization SHALL at least have a name or an id, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "(also see master files messages)"
},
{
"identity": "rim",
"map": "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity": "servd",
"map": "Organization"
}
]
},
{
"path": "Organization.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Organization.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Organization.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Organization.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Organization.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Organization.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Organization.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Organization.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Organization.identifier",
"short": "Identifies this organization across multiple systems",
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"condition": [
"org-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XON.10 Organization Identifier / XON.3 ID Number"
},
{
"identity": "rim",
"map": ".scopes[Role](classCode=IDENT)"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
},
{
"path": "Organization.name",
"short": "Name used for the organization",
"definition": "A name associated with the organization.",
"requirements": "Need to use the name as the label of the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"org-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XON.1 Organization Name"
},
{
"identity": "rim",
"map": ".name"
},
{
"identity": "servd",
"map": ".PreferredName/Name"
}
]
},
{
"path": "Organization.type",
"short": "Kind of organization",
"definition": "The kind of organization that this is.",
"comments": "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes.",
"requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "OrganizationType",
"strength": "example",
"description": "Used to categorize the organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/organization-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "No equivalent in v2"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "servd",
"map": "n/a"
}
]
},
{
"path": "Organization.telecom",
"short": "A contact detail for the organization",
"definition": "A contact detail for the organization.",
"comments": "The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"requirements": "Human contact for the organization.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"condition": [
"org-3"
],
"constraint": [
{
"key": "org-3",
"name": "NoHomeUseTelecom",
"severity": "error",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x"
},
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
},
{
"path": "Organization.address",
"short": "An address for the organization",
"definition": "An address for the organization.",
"comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.",
"requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"condition": [
"org-2"
],
"constraint": [
{
"key": "org-2",
"name": "NoHomeUseAddress",
"severity": "error",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"
},
{
"identity": "rim",
"map": ".address"
},
{
"identity": "servd",
"map": "./PrimaryAddress and ./OtherAddresses"
}
]
},
{
"path": "Organization.partOf",
"short": "The organization of which this organization forms a part",
"definition": "The organization of which this organization forms a part.",
"requirements": "Need to be able to track the hierarchy of organizations within an organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "rim",
"map": ".playedBy[classCode=Part].scoper"
},
{
"identity": "servd",
"map": "n/a"
}
]
},
{
"path": "Organization.contact",
"short": "Contact for the organization for a certain purpose",
"definition": "Contact for the organization for a certain purpose.",
"requirements": "Need to keep track of assigned contact points within bigger organization.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".contactParty"
}
]
},
{
"path": "Organization.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Organization.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Organization.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Organization.contact.purpose",
"short": "The type of contact",
"definition": "Indicates a purpose for which the contact can be reached.",
"requirements": "Need to distinguish between multiple contact persons.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContactPartyType",
"strength": "required",
"description": "The purpose for which you would contact a contact party",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contactentity-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./type"
}
]
},
{
"path": "Organization.contact.name",
"short": "A name associated with the contact",
"definition": "A name associated with the contact.",
"requirements": "Need to be able to track the person by name.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "Organization.contact.telecom",
"short": "Contact details (telephone, email, etc) for a contact",
"definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "Organization.contact.address",
"short": "Visiting or postal addresses for the contact",
"definition": "Visiting or postal addresses for the contact.",
"requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "./addr"
}
]
},
{
"path": "Organization.active",
"short": "Whether the organization's record is still in active use",
"definition": "Whether the organization's record is still in active use.",
"comments": "Default is true.",
"requirements": "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "rim",
"map": ".status"
},
{
"identity": "servd",
"map": "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}
]
}
]
},
"differential": {
"element": [
{
"path": "Organization",
"short": "A grouping of people or organizations with a common purpose",
"definition": "A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "org-1",
"name": "AtLeastANameOrId",
"severity": "error",
"human": "The organization SHALL at least have a name or an id, and possibly more than one",
"xpath": "count(f:identifier | f:name) > 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "(also see master files messages)"
},
{
"identity": "rim",
"map": "Organization(classCode=ORG, determinerCode=INST)"
},
{
"identity": "servd",
"map": "Organization"
}
]
},
{
"path": "Organization.identifier",
"short": "Identifies this organization across multiple systems",
"definition": "Identifier for the organization that is used to identify the organization across multiple disparate systems.",
"requirements": "Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"condition": [
"org-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XON.10 Organization Identifier / XON.3 ID Number"
},
{
"identity": "rim",
"map": ".scopes[Role](classCode=IDENT)"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
},
{
"path": "Organization.name",
"short": "Name used for the organization",
"definition": "A name associated with the organization.",
"requirements": "Need to use the name as the label of the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"org-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XON.1 Organization Name"
},
{
"identity": "rim",
"map": ".name"
},
{
"identity": "servd",
"map": ".PreferredName/Name"
}
]
},
{
"path": "Organization.type",
"short": "Kind of organization",
"definition": "The kind of organization that this is.",
"comments": "Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes.",
"requirements": "Need to be able to track the kind of organization that this is - different organization types have different uses.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "OrganizationType",
"strength": "example",
"description": "Used to categorize the organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/organization-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "No equivalent in v2"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "servd",
"map": "n/a"
}
]
},
{
"path": "Organization.telecom",
"short": "A contact detail for the organization",
"definition": "A contact detail for the organization.",
"comments": "The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.",
"requirements": "Human contact for the organization.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"condition": [
"org-3"
],
"constraint": [
{
"key": "org-3",
"name": "NoHomeUseTelecom",
"severity": "error",
"human": "The telecom of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x"
},
{
"identity": "rim",
"map": ".telecom"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
},
{
"path": "Organization.address",
"short": "An address for the organization",
"definition": "An address for the organization.",
"comments": "Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used.",
"requirements": "May need to keep track of the organization's addresses for contacting, billing or reporting requirements.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"condition": [
"org-2"
],
"constraint": [
{
"key": "org-2",
"name": "NoHomeUseAddress",
"severity": "error",
"human": "An address of an organization can never be of use 'home'",
"xpath": "count(f:use[@value='home']) = 0"
}
],
"mapping": [
{
"identity": "v2",
"map": "No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"
},
{
"identity": "rim",
"map": ".address"
},
{
"identity": "servd",
"map": "./PrimaryAddress and ./OtherAddresses"
}
]
},
{
"path": "Organization.partOf",
"short": "The organization of which this organization forms a part",
"definition": "The organization of which this organization forms a part.",
"requirements": "Need to be able to track the hierarchy of organizations within an organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "rim",
"map": ".playedBy[classCode=Part].scoper"
},
{
"identity": "servd",
"map": "n/a"
}
]
},
{
"path": "Organization.contact",
"short": "Contact for the organization for a certain purpose",
"definition": "Contact for the organization for a certain purpose.",
"requirements": "Need to keep track of assigned contact points within bigger organization.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".contactParty"
}
]
},
{
"path": "Organization.contact.purpose",
"short": "The type of contact",
"definition": "Indicates a purpose for which the contact can be reached.",
"requirements": "Need to distinguish between multiple contact persons.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContactPartyType",
"strength": "required",
"description": "The purpose for which you would contact a contact party",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/contactentity-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./type"
}
]
},
{
"path": "Organization.contact.name",
"short": "A name associated with the contact",
"definition": "A name associated with the contact.",
"requirements": "Need to be able to track the person by name.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "Organization.contact.telecom",
"short": "Contact details (telephone, email, etc) for a contact",
"definition": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "Organization.contact.address",
"short": "Visiting or postal addresses for the contact",
"definition": "Visiting or postal addresses for the contact.",
"requirements": "May need to keep track of a contact party's address for contacting, billing or reporting requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "./addr"
}
]
},
{
"path": "Organization.active",
"short": "Whether the organization's record is still in active use",
"definition": "Whether the organization's record is still in active use.",
"comments": "Default is true.",
"requirements": "Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "No equivalent in V2.x"
},
{
"identity": "rim",
"map": ".status"
},
{
"identity": "servd",
"map": "./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date."
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Other",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Other",
"name": "Other",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Other Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Other",
"short": "Resource for non-supported content",
"definition": "Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
"requirements": "Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.",
"alias": [
"Z-resource",
"Extension-resource",
"Custom-resource"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Other"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act, Entity or Role"
}
]
},
{
"path": "Other.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Other.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Other.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Other.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Other.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Other.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Other.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Other.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Other.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "./identifier"
}
]
},
{
"path": "Other.code",
"short": "Kind of Resource",
"definition": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comments": "Because resource references will only be able to indicate 'Other', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.",
"requirements": "Must be able to distinguish different types of \"other\" resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "OtherResourceType",
"strength": "example",
"description": "Codes for identifying types of resources not yet defined by FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/other-resource-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Other.subject",
"short": "Identifies the",
"definition": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
"comments": "Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements": "Needed for partitioning the resource by Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Other.author",
"short": "Who created",
"definition": "Indicates who was responsible for creating the resource instance.",
"requirements": "Needed for partitioning the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Other.created",
"short": "When created",
"definition": "Identifies when the resource was first created.",
"requirements": "Allows ordering resource instances by time.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Other",
"short": "Resource for non-supported content",
"definition": "Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
"requirements": "Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.",
"alias": [
"Z-resource",
"Extension-resource",
"Custom-resource"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Act, Entity or Role"
}
]
},
{
"path": "Other.identifier",
"short": "Business identifier",
"definition": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": "./identifier"
}
]
},
{
"path": "Other.code",
"short": "Kind of Resource",
"definition": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
"comments": "Because resource references will only be able to indicate 'Other', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.",
"requirements": "Must be able to distinguish different types of \"other\" resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": true,
"binding": {
"name": "OtherResourceType",
"strength": "example",
"description": "Codes for identifying types of resources not yet defined by FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/other-resource-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Other.subject",
"short": "Identifies the",
"definition": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
"comments": "Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.",
"requirements": "Needed for partitioning the resource by Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Other.author",
"short": "Who created",
"definition": "Indicates who was responsible for creating the resource instance.",
"requirements": "Needed for partitioning the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
]
},
{
"path": "Other.created",
"short": "When created",
"definition": "Identifies when the resource was first created.",
"requirements": "Allows ordering resource instances by time.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Patient-everything",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Patient-everything",
"name": "Fetch Patient Record",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "This operation is used to return all the information related to patient described in the resource on which this operation is invoked. The response is a bundle of type \"searchset\". At a minimum, the patient resource itself is returned, along with any other resources that the server has available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for rhis operation is to provide a patient with access to their records (e.g. \"Blue Button\").\r\rThe server SHOULD return all resources that it has that are in the patient compartment for the identified patient, and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (ref to be provided). Other applicable implementation guides may make additional rules about the information that is returned. Note: the expectations here will be refined after experience with this at connectathon.",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "everything",
"notes": "The key differences between this operation and simply searching the patient compartment are:\r\r* unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)\r* the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)\r\rIt is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Speciying the relationship between the context, a user and patient records is outside the scope of this specification.",
"system": false,
"type": [
"Patient"
],
"instance": true,
"parameter": [
{
"name": "start",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date range relates to care dates, not record currency dates - e.g all records relating to care provided in a certain date range. If no date is provided, all records are in scope.",
"type": "date"
},
{
"name": "end",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The date range relates to care dates, not record currency dates - e.g all records relating to care provided in a certain date range. If no date is provided, all records are in scope.",
"type": "date"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The bundle type is \"searchset\"",
"type": "Bundle"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Patient",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Patient",
"name": "Patient",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Patient Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "loinc",
"uri": "http://loinc.org",
"name": "LOINC"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Patient",
"short": "Information about an individual or animal receiving health care services",
"definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"requirements": "Tracking patient is the center of the healthcare process.",
"alias": [
"SubjectOfCare Client Resident"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
}
]
},
{
"path": "Patient.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Patient.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Patient.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Patient.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Patient.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Patient.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.identifier",
"short": "An identifier for this patient",
"definition": "An identifier for this patient.",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Patient.name",
"short": "A name associated with the patient",
"definition": "A name associated with the individual.",
"comments": "A Patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "Patient.telecom",
"short": "A contact detail for the individual",
"definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comments": "A Patient may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "Patient.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comments": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. \nSystems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a \"hard\" error.",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-8"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Patient.birthDate",
"short": "The date of birth for the individual",
"definition": "The date of birth for the individual.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"requirements": "Age of the individual drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "21112-8"
},
{
"identity": "v2",
"map": "PID-7"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
}
]
},
{
"path": "Patient.deceased[x]",
"short": "Indicates if the individual is deceased or not",
"definition": "Indicates if the individual is deceased or not.",
"comments": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-30\r (bool) and PID-29 (datetime)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd,\rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
}
]
},
{
"path": "Patient.address",
"short": "Addresses for the individual",
"definition": "Addresses for the individual.",
"comments": "Patient may have multiple addresses with different uses or applicable periods.",
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "Patient.maritalStatus",
"short": "Marital (civil) status of a patient",
"definition": "This field contains a patient's most recent marital (civil) status.",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MaritalStatus",
"strength": "required",
"description": "The domestic partnership status of a person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/marital-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-16"
},
{
"identity": "rim",
"map": "player[classCode=PSN]/maritalStatusCode"
}
]
},
{
"path": "Patient.multipleBirth[x]",
"short": "Whether patient is part of a multiple birth",
"definition": "Indicates whether the patient is part of a multiple or indicates the actual birth order.",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-24 (bool), PID-25 (integer)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, \rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
}
]
},
{
"path": "Patient.photo",
"short": "Image of the patient",
"definition": "Image of the patient.",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"path": "Patient.contact",
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"definition": "A contact party (e.g. guardian, partner, friend) for the patient.",
"comments": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"requirements": "Need to track people you can contact about the patient.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "pat-1",
"name": "ContactNeedsDetails",
"severity": "error",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "f:name or f:telecom or f:address or f:organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
}
]
},
{
"path": "Patient.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.contact.relationship",
"short": "The kind of relationship",
"definition": "The nature of the relationship between the patient and the contact person.",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContactRelationship",
"strength": "required",
"description": "The nature of the relationship between a patient and a contact person for that patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-7, NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Patient.contact.name",
"short": "A name associated with the contact person",
"definition": "A name associated with the contact person.",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "Patient.contact.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Contact may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "Patient.contact.address",
"short": "Address for the contact person",
"definition": "Address for the contact person.",
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-4"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "Patient.contact.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"requirements": "Needed to address the person correctly.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Patient.contact.organization",
"short": "Organization that is associated with the contact",
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
"requirements": "For guardians or business related contacts, the organization is relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition": [
"pat-1"
],
"mapping": [
{
"identity": "v2",
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Patient.contact.period",
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "Patient.animal",
"short": "If this patient is an animal (non-human)",
"definition": "This element has a value if the patient is an animal.",
"comments": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject non-human patient records.",
"requirements": "Many clinical systems are extended to care for animal patients as well as human.",
"min": 0,
"max": "1",
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=ANM]"
}
]
},
{
"path": "Patient.animal.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.animal.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.animal.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.animal.species",
"short": "E.g. Dog, Cow",
"definition": "Identifies the high level taxonomic categorization of the kind of animal.",
"comments": "If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word \"Hereford\" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED code for \"Hereford Cattle Breed\" does.).",
"requirements": "Need to know what kind of animal.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalSpecies",
"strength": "example",
"description": "The species of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-species"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-35"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Patient.animal.breed",
"short": "E.g. Poodle, Angus",
"definition": "Identifies the detailed categorization of the kind of animal.",
"comments": "Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.",
"requirements": "May need to know the specific kind within the species.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalBreed",
"strength": "example",
"description": "The breed of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-breeds"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-37"
},
{
"identity": "rim",
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
}
]
},
{
"path": "Patient.animal.genderStatus",
"short": "E.g. Neutered, Intact",
"definition": "Indicates the current state of the animal's reproductive organs.",
"requirements": "Gender status can affect housing and animal behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalGenderStatus",
"strength": "example",
"description": "The state of the animal's reproductive organs",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-genderstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "genderStatusCode"
}
]
},
{
"path": "Patient.communication",
"short": "A list of Languages which may be used to communicate with the patient about his or her health",
"definition": "Languages which may be used to communicate with the patient about his or her health.",
"comments": "If no language is specified, this *implies* that the default local language is spoken.\rIf you need to convey proficiency for multiple modes than you need multiple Patient.Communication associations. \r\rFor animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements": "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "LanguageCommunication"
}
]
},
{
"path": "Patient.communication.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.communication.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.communication.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.communication.language",
"short": "The language which can be used to communicate with the patient about his or her health",
"definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case. E.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comments": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "v2",
"map": "PID-15, LAN-2"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
}
]
},
{
"path": "Patient.communication.preferred",
"short": "Language preference indicator",
"definition": "Indicates whether or not the Patient prefers this language (over other languages he masters up a certain level).",
"comments": "This language is specifically identified for communicating healthcare information.",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-15"
},
{
"identity": "rim",
"map": "preferenceInd"
}
]
},
{
"path": "Patient.careProvider",
"short": "Patient's nominated care provider",
"definition": "Patient's nominated care provider.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.CareEvent.performer.AssignedEntity"
}
]
},
{
"path": "Patient.managingOrganization",
"short": "Organization that is the custodian of the patient record",
"definition": "Organization that is the custodian of the patient record.",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Patient.link",
"short": "Link to another patient resource that concerns the same actual person",
"definition": "Link to another patient resource that concerns the same actual patient.",
"comments": "There is no assumption that linked patient records have mutual links.",
"requirements": "There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "outboundLink"
}
]
},
{
"path": "Patient.link.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.link.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.link.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.link.other",
"short": "The other patient resource that the link refers to",
"definition": "The other patient resource that the link refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3, MRG-1"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Patient.link.type",
"short": "replace | refer | seealso - type of link",
"definition": "The type of link between this patient resource and another patient resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LinkType",
"strength": "required",
"description": "The type of link between this patient resource and another patient resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/link-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "typeCode"
}
]
},
{
"path": "Patient.active",
"short": "Whether this patient's record is in active use",
"definition": "Whether this patient record is in active use.",
"comments": "Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Patient",
"short": "Information about an individual or animal receiving health care services",
"definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"requirements": "Tracking patient is the center of the healthcare process.",
"alias": [
"SubjectOfCare Client Resident"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
}
]
},
{
"path": "Patient.identifier",
"short": "An identifier for this patient",
"definition": "An identifier for this patient.",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Patient.name",
"short": "A name associated with the patient",
"definition": "A name associated with the individual.",
"comments": "A Patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "Patient.telecom",
"short": "A contact detail for the individual",
"definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comments": "A Patient may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "Patient.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comments": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. \nSystems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a \"hard\" error.",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-8"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Patient.birthDate",
"short": "The date of birth for the individual",
"definition": "The date of birth for the individual.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"requirements": "Age of the individual drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "21112-8"
},
{
"identity": "v2",
"map": "PID-7"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
}
]
},
{
"path": "Patient.deceased[x]",
"short": "Indicates if the individual is deceased or not",
"definition": "Indicates if the individual is deceased or not.",
"comments": "If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-30\r (bool) and PID-29 (datetime)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd,\rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
}
]
},
{
"path": "Patient.address",
"short": "Addresses for the individual",
"definition": "Addresses for the individual.",
"comments": "Patient may have multiple addresses with different uses or applicable periods.",
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "Patient.maritalStatus",
"short": "Marital (civil) status of a patient",
"definition": "This field contains a patient's most recent marital (civil) status.",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MaritalStatus",
"strength": "required",
"description": "The domestic partnership status of a person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/marital-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-16"
},
{
"identity": "rim",
"map": "player[classCode=PSN]/maritalStatusCode"
}
]
},
{
"path": "Patient.multipleBirth[x]",
"short": "Whether patient is part of a multiple birth",
"definition": "Indicates whether the patient is part of a multiple or indicates the actual birth order.",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-24 (bool), PID-25 (integer)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, \rplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
}
]
},
{
"path": "Patient.photo",
"short": "Image of the patient",
"definition": "Image of the patient.",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"path": "Patient.contact",
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"definition": "A contact party (e.g. guardian, partner, friend) for the patient.",
"comments": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"requirements": "Need to track people you can contact about the patient.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "pat-1",
"name": "ContactNeedsDetails",
"severity": "error",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "f:name or f:telecom or f:address or f:organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
}
]
},
{
"path": "Patient.contact.relationship",
"short": "The kind of relationship",
"definition": "The nature of the relationship between the patient and the contact person.",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ContactRelationship",
"strength": "required",
"description": "The nature of the relationship between a patient and a contact person for that patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-7, NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Patient.contact.name",
"short": "A name associated with the contact person",
"definition": "A name associated with the contact person.",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "Patient.contact.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Contact may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "Patient.contact.address",
"short": "Address for the contact person",
"definition": "Address for the contact person.",
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "NK1-4"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "Patient.contact.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"requirements": "Needed to address the person correctly.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Patient.contact.organization",
"short": "Organization that is associated with the contact",
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
"requirements": "For guardians or business related contacts, the organization is relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition": [
"pat-1"
],
"mapping": [
{
"identity": "v2",
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Patient.contact.period",
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "Patient.animal",
"short": "If this patient is an animal (non-human)",
"definition": "This element has a value if the patient is an animal.",
"comments": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject non-human patient records.",
"requirements": "Many clinical systems are extended to care for animal patients as well as human.",
"min": 0,
"max": "1",
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "player[classCode=ANM]"
}
]
},
{
"path": "Patient.animal.species",
"short": "E.g. Dog, Cow",
"definition": "Identifies the high level taxonomic categorization of the kind of animal.",
"comments": "If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word \"Hereford\" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED code for \"Hereford Cattle Breed\" does.).",
"requirements": "Need to know what kind of animal.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalSpecies",
"strength": "example",
"description": "The species of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-species"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-35"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Patient.animal.breed",
"short": "E.g. Poodle, Angus",
"definition": "Identifies the detailed categorization of the kind of animal.",
"comments": "Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.",
"requirements": "May need to know the specific kind within the species.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalBreed",
"strength": "example",
"description": "The breed of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-breeds"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-37"
},
{
"identity": "rim",
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
}
]
},
{
"path": "Patient.animal.genderStatus",
"short": "E.g. Neutered, Intact",
"definition": "Indicates the current state of the animal's reproductive organs.",
"requirements": "Gender status can affect housing and animal behavior.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalGenderStatus",
"strength": "example",
"description": "The state of the animal's reproductive organs",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-genderstatus"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "genderStatusCode"
}
]
},
{
"path": "Patient.communication",
"short": "A list of Languages which may be used to communicate with the patient about his or her health",
"definition": "Languages which may be used to communicate with the patient about his or her health.",
"comments": "If no language is specified, this *implies* that the default local language is spoken.\rIf you need to convey proficiency for multiple modes than you need multiple Patient.Communication associations. \r\rFor animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements": "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "LanguageCommunication"
}
]
},
{
"path": "Patient.communication.language",
"short": "The language which can be used to communicate with the patient about his or her health",
"definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case. E.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comments": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "v2",
"map": "PID-15, LAN-2"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
}
]
},
{
"path": "Patient.communication.preferred",
"short": "Language preference indicator",
"definition": "Indicates whether or not the Patient prefers this language (over other languages he masters up a certain level).",
"comments": "This language is specifically identified for communicating healthcare information.",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-15"
},
{
"identity": "rim",
"map": "preferenceInd"
}
]
},
{
"path": "Patient.careProvider",
"short": "Patient's nominated care provider",
"definition": "Patient's nominated care provider.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": "subjectOf.CareEvent.performer.AssignedEntity"
}
]
},
{
"path": "Patient.managingOrganization",
"short": "Organization that is the custodian of the patient record",
"definition": "Organization that is the custodian of the patient record.",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Patient.link",
"short": "Link to another patient resource that concerns the same actual person",
"definition": "Link to another patient resource that concerns the same actual patient.",
"comments": "There is no assumption that linked patient records have mutual links.",
"requirements": "There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.",
"min": 0,
"max": "*",
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "outboundLink"
}
]
},
{
"path": "Patient.link.other",
"short": "The other patient resource that the link refers to",
"definition": "The other patient resource that the link refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3, MRG-1"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Patient.link.type",
"short": "replace | refer | seealso - type of link",
"definition": "The type of link between this patient resource and another patient resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LinkType",
"strength": "required",
"description": "The type of link between this patient resource and another patient resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/link-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "typeCode"
}
]
},
{
"path": "Patient.active",
"short": "Whether this patient's record is in active use",
"definition": "Whether this patient record is in active use.",
"comments": "Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "PaymentNotice",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
"name": "PaymentNotice",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for PaymentNotice Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "PaymentNotice",
"short": "PaymentNotice request",
"definition": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"min": 1,
"max": "1",
"type": [
{
"code": "PaymentNotice"
}
]
},
{
"path": "PaymentNotice.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "PaymentNotice.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "PaymentNotice.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "PaymentNotice.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "PaymentNotice.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "PaymentNotice.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentNotice.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentNotice.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentNotice.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "PaymentNotice.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentNotice.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentNotice.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "PaymentNotice.target",
"short": "Insurer or Regulatory body",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentNotice.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "PaymentNotice.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentNotice.request",
"short": "Request reference",
"definition": "Reference of resource to reverse.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentNotice.response",
"short": "Response reference",
"definition": "Reference of response to resource to reverse.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentNotice.paymentStatus",
"short": "Status of the payment",
"definition": "The payment status, typically paid: payment sent, cleared: payment received.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PaymentStatus",
"strength": "example",
"description": "The payment conveyance status codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payment-status"
}
}
}
]
},
"differential": {
"element": [
{
"path": "PaymentNotice",
"short": "PaymentNotice request",
"definition": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "PaymentNotice.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "PaymentNotice.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentNotice.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentNotice.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "PaymentNotice.target",
"short": "Insurer or Regulatory body",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentNotice.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "PaymentNotice.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentNotice.request",
"short": "Request reference",
"definition": "Reference of resource to reverse.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentNotice.response",
"short": "Response reference",
"definition": "Reference of response to resource to reverse.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentNotice.paymentStatus",
"short": "Status of the payment",
"definition": "The payment status, typically paid: payment sent, cleared: payment received.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PaymentStatus",
"strength": "example",
"description": "The payment conveyance status codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payment-status"
}
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "PaymentReconciliation",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation",
"name": "PaymentReconciliation",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for PaymentReconciliation Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "PaymentReconciliation",
"short": "PaymentReconciliation resource",
"definition": "This resource provides payment details and claim references supporting a bulk payment.",
"min": 1,
"max": "1",
"type": [
{
"code": "PaymentReconciliation"
}
]
},
{
"path": "PaymentReconciliation.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "PaymentReconciliation.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "PaymentReconciliation.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "PaymentReconciliation.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "PaymentReconciliation.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "PaymentReconciliation.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentReconciliation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentReconciliation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentReconciliation.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "PaymentReconciliation.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "PaymentReconciliation.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "PaymentReconciliation.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "PaymentReconciliation.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentReconciliation.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentReconciliation.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "PaymentReconciliation.period",
"short": "Period covered",
"definition": "The period of time for which payments have been gathered into this bulk payment for settlement.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "PaymentReconciliation.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "PaymentReconciliation.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail",
"short": "Details",
"definition": "List of individual settlement amounts and the corresponding transaction.",
"min": 0,
"max": "*"
},
{
"path": "PaymentReconciliation.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "PaymentReconciliation.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "PaymentReconciliation.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentReconciliation.detail.type",
"short": "Type code",
"definition": "Code to indicate the nature of the payment, adjustment, funds advance, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PaymentType",
"strength": "example",
"description": "The reason for the amount: payment, adjustment, advance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payment-type"
}
}
},
{
"path": "PaymentReconciliation.detail.request",
"short": "Claim",
"definition": "The claim or financial resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentReconciliation.detail.responce",
"short": "Claim Response",
"definition": "The claim response resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentReconciliation.detail.submitter",
"short": "Submitter",
"definition": "The Organization which submitted the invoice or financial transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail.payee",
"short": "Payee",
"definition": "The organization which is receiving the payment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail.date",
"short": "Invoice date",
"definition": "The date of the invoice or financial resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "PaymentReconciliation.detail.amount",
"short": "Detail amount",
"definition": "Amount paid for this detail.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "PaymentReconciliation.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "PaymentReconciliation.total",
"short": "Total amount of Payment",
"definition": "Total payment amount.",
"min": 1,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "PaymentReconciliation.note",
"short": "Note text",
"definition": "Suite of notes.",
"min": 0,
"max": "*"
},
{
"path": "PaymentReconciliation.note.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "PaymentReconciliation.note.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "PaymentReconciliation.note.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "PaymentReconciliation.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "PaymentReconciliation.note.text",
"short": "Notes text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
}
]
},
"differential": {
"element": [
{
"path": "PaymentReconciliation",
"short": "PaymentReconciliation resource",
"definition": "This resource provides payment details and claim references supporting a bulk payment.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "PaymentReconciliation.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "PaymentReconciliation.request",
"short": "Claim reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "PaymentReconciliation.outcome",
"short": "complete | error",
"definition": "Transaction status: error, complete.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "RemittanceOutcome",
"strength": "required",
"description": "The outcome of the processing.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/RS-link"
}
}
},
{
"path": "PaymentReconciliation.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "PaymentReconciliation.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentReconciliation.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "PaymentReconciliation.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "PaymentReconciliation.period",
"short": "Period covered",
"definition": "The period of time for which payments have been gathered into this bulk payment for settlement.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"path": "PaymentReconciliation.organization",
"short": "Insurer",
"definition": "The Insurer who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.requestProvider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "PaymentReconciliation.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail",
"short": "Details",
"definition": "List of individual settlement amounts and the corresponding transaction.",
"min": 0,
"max": "*"
},
{
"path": "PaymentReconciliation.detail.type",
"short": "Type code",
"definition": "Code to indicate the nature of the payment, adjustment, funds advance, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "PaymentType",
"strength": "example",
"description": "The reason for the amount: payment, adjustment, advance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/payment-type"
}
}
},
{
"path": "PaymentReconciliation.detail.request",
"short": "Claim",
"definition": "The claim or financial resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentReconciliation.detail.responce",
"short": "Claim Response",
"definition": "The claim response resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "PaymentReconciliation.detail.submitter",
"short": "Submitter",
"definition": "The Organization which submitted the invoice or financial transaction.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail.payee",
"short": "Payee",
"definition": "The organization which is receiving the payment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "PaymentReconciliation.detail.date",
"short": "Invoice date",
"definition": "The date of the invoice or financial resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"path": "PaymentReconciliation.detail.amount",
"short": "Detail amount",
"definition": "Amount paid for this detail.",
"min": 0,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "PaymentReconciliation.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "PaymentReconciliation.total",
"short": "Total amount of Payment",
"definition": "Total payment amount.",
"min": 1,
"max": "1",
"type": [
{
"code": "Money"
}
]
},
{
"path": "PaymentReconciliation.note",
"short": "Note text",
"definition": "Suite of notes.",
"min": 0,
"max": "*"
},
{
"path": "PaymentReconciliation.note.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "PaymentReconciliation.note.text",
"short": "Notes text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Person",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Person",
"name": "Person",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Person Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Person",
"short": "A generic person record",
"definition": "Demographics and administrative information about a person independent of a specific health-related context.",
"comments": "The Person resource does justice to Person registries that keep track of Persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).",
"requirements": "Need to track persons potentially across multiple roles.",
"min": 1,
"max": "1",
"type": [
{
"code": "Person"
}
],
"mapping": [
{
"identity": "rim",
"map": "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")"
}
]
},
{
"path": "Person.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Person.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Person.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Person.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Person.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Person.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Person.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Person.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Person.identifier",
"short": "A Human identifier for this person",
"definition": "Identifier for a person within a particular scope.",
"requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".plays:Role(classCode='IDENT').id"
}
]
},
{
"path": "Person.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"comments": "Person may have multiple names with different uses or applicable periods.",
"requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "Person.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "Person.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender.",
"comments": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F.",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-8"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Person.birthDate",
"short": "The birth date for the person",
"definition": "The birth date for the person.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"requirements": "Age of person drives many clinical processes. Next to the common use case of capturing someone birth date, also in some common cases time is registered.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-7"
},
{
"identity": "rim",
"map": "./birthTime"
}
]
},
{
"path": "Person.address",
"short": "One or more addresses for the person",
"definition": "One or more addresses for the person.",
"comments": "Person may have multiple addresses with different uses or applicable periods.",
"requirements": "May need to keep track of persons addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "./addr"
}
]
},
{
"path": "Person.photo",
"short": "Image of the Person",
"definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"path": "Person.managingOrganization",
"short": "The Organization that is the custodian of the person record",
"definition": "The Organization that is the custodian of the person record.",
"requirements": "Need to know who recognizes this person record, manages and updates it.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Person.active",
"short": "This person's record is in active use",
"definition": "Whether this person's record is in active use.",
"requirements": "Need to be able to mark a person record as not to be used because it was created in error.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Person.link",
"short": "Link to a resource that concerns the same actual person",
"definition": "Link to a resource that concerns the same actual person.",
"min": 0,
"max": "*"
},
{
"path": "Person.link.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Person.link.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Person.link.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Person.link.target",
"short": "The resource to which this actual person is associated",
"definition": "The resource to which this actual person is associated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Person"
}
]
},
{
"path": "Person.link.assurance",
"short": "level1 | level2 | level3 | level4",
"definition": "Level of assurance that this link is actually associated with the target resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "IdentityAssuranceLevel",
"strength": "required",
"description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/identity-assuranceLevel"
}
}
}
]
},
"differential": {
"element": [
{
"path": "Person",
"short": "A generic person record",
"definition": "Demographics and administrative information about a person independent of a specific health-related context.",
"comments": "The Person resource does justice to Person registries that keep track of Persons regardless of their role. The Person resource is also a primary resource to point to for people acting in a particular role such as SubjectofCare, Practitioner, and Agent. Very few attributes are specific to any role and so Person is kept lean. Most attributes are expected to be tied to the role the Person plays rather than the Person himself. Examples of that are Guardian (SubjectofCare), ContactParty (SubjectOfCare, Practitioner), and multipleBirthInd (SubjectofCare).",
"requirements": "Need to track persons potentially across multiple roles.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")"
}
]
},
{
"path": "Person.identifier",
"short": "A Human identifier for this person",
"definition": "Identifier for a person within a particular scope.",
"requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the person. Examples are national person identifier and local identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".plays:Role(classCode='IDENT').id"
}
]
},
{
"path": "Person.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"comments": "Person may have multiple names with different uses or applicable periods.",
"requirements": "Need to be able to track the person by multiple names. Examples are your official name and a partner name.",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "Person.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-13, PID-14"
},
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "Person.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender.",
"comments": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F.",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date. Gender of person drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "PID-8"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Person.birthDate",
"short": "The birth date for the person",
"definition": "The birth date for the person.",
"comments": "At least an estimated year should be provided as a guess if the real dob is unknown.",
"requirements": "Age of person drives many clinical processes. Next to the common use case of capturing someone birth date, also in some common cases time is registered.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-7"
},
{
"identity": "rim",
"map": "./birthTime"
}
]
},
{
"path": "Person.address",
"short": "One or more addresses for the person",
"definition": "One or more addresses for the person.",
"comments": "Person may have multiple addresses with different uses or applicable periods.",
"requirements": "May need to keep track of persons addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "./addr"
}
]
},
{
"path": "Person.photo",
"short": "Image of the Person",
"definition": "An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"path": "Person.managingOrganization",
"short": "The Organization that is the custodian of the person record",
"definition": "The Organization that is the custodian of the person record.",
"requirements": "Need to know who recognizes this person record, manages and updates it.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"path": "Person.active",
"short": "This person's record is in active use",
"definition": "Whether this person's record is in active use.",
"requirements": "Need to be able to mark a person record as not to be used because it was created in error.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Person.link",
"short": "Link to a resource that concerns the same actual person",
"definition": "Link to a resource that concerns the same actual person.",
"min": 0,
"max": "*"
},
{
"path": "Person.link.target",
"short": "The resource to which this actual person is associated",
"definition": "The resource to which this actual person is associated.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Person"
}
]
},
{
"path": "Person.link.assurance",
"short": "level1 | level2 | level3 | level4",
"definition": "Level of assurance that this link is actually associated with the target resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "IdentityAssuranceLevel",
"strength": "required",
"description": "The level of confidence that this link represents the same actual person, based on NIST Authentication Levels",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/identity-assuranceLevel"
}
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Practitioner",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"name": "Practitioner",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Practitioner Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Practitioner",
"short": "A person with a formal responsibility in the provisioning of healthcare or related services",
"definition": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?",
"requirements": "Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "rim",
"map": "Role"
},
{
"identity": "servd",
"map": "Provider"
}
]
},
{
"path": "Practitioner.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Practitioner.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Practitioner.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Practitioner.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Practitioner.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Practitioner.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Practitioner.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Practitioner.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Practitioner.identifier",
"short": "A identifier for the person as this agent",
"definition": "An identifier that applies to this person in this role.",
"requirements": "Often, specific identities are assigned for the agent.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRD-7 (or XCN.1 Person Identifier)"
},
{
"identity": "rim",
"map": "./id"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
},
{
"path": "Practitioner.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XCN Components"
},
{
"identity": "rim",
"map": "./name"
},
{
"identity": "servd",
"map": "./PreferredName (GivenNames, FamilyName, TitleCode)"
}
]
},
{
"path": "Practitioner.telecom",
"short": "A contact detail for the practitioner",
"definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "Need to know how to reach a practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT-15, STF-10, ROL-12"
},
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
},
{
"path": "Practitioner.address",
"short": "Where practitioner can be found/visited",
"definition": "The postal address where the practitioner can be found or visited or to which mail can be delivered.",
"requirements": "Need to keep track where the practitioner can found during work or for directing mail.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "servd",
"map": "./Addresses"
}
]
},
{
"path": "Practitioner.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements": "Needed to address the person correctly.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "STF-5"
},
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "servd",
"map": "./GenderCode"
}
]
},
{
"path": "Practitioner.birthDate",
"short": "The date of birth for the practitioner",
"definition": "The date of birth for the practitioner.",
"requirements": "Needed for identification.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "STF-6"
},
{
"identity": "rim",
"map": "./birthTime"
},
{
"identity": "servd",
"map": "(not represented in ServD)"
}
]
},
{
"path": "Practitioner.photo",
"short": "Image of the person",
"definition": "Image of the person.",
"requirements": "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
]
},
{
"path": "Practitioner.practitionerRole",
"short": "The list of Roles/Organizations that the Practitioner is associated with",
"definition": "The list of Roles/Organizations that the Practitioner is associated with.",
"min": 0,
"max": "*"
},
{
"path": "Practitioner.practitionerRole.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Practitioner.practitionerRole.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Practitioner.practitionerRole.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Practitioner.practitionerRole.managingOrganization",
"short": "The Organization where the Practitioner performs the roles associated",
"definition": "The Organization where the Practitioner performs the roles associated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Practitioner.practitionerRole.role",
"short": "Roles which this practitioner may perform",
"definition": "Roles which this practitioner is authorized to perform for the organization.",
"comments": "A person may have more than one role. At least one role is required.",
"requirements": "Need to know what authority the practitioner has - what can they do?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PractitionerRole",
"strength": "example",
"description": "The role a person plays representing an organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/practitioner-role"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRD-1 / STF-18-job title / PRA-3-practitioner category / PRT-4-Participation / ROL-3-role-ROL / ORC-12-ordering provider / OBR-16-ordering provider / PV1-7-attending doctor / PV1-8-referring doctor / PV1-9-consulting doctor / PV1-17-admitting doctor"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
},
{
"path": "Practitioner.practitionerRole.specialty",
"short": "Specific specialty of the practitioner",
"definition": "Specific specialty of the practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PractitionerSpecialty",
"strength": "example",
"description": "Specific specialty associated with the agency",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/practitioner-specialty"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRA-5-specialty"
},
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "servd",
"map": "./Specialty"
}
]
},
{
"path": "Practitioner.practitionerRole.period",
"short": "The period during which the practitioner is authorized to perform in these role(s)",
"definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRD-8/9 / PRA-5.4-date of certification"
},
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
},
{
"path": "Practitioner.practitionerRole.location",
"short": "The location(s) at which this practitioner provides care",
"definition": "The location(s) at which this practitioner provides care.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/>\rHowever these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}
]
},
{
"path": "Practitioner.practitionerRole.healthcareService",
"short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}
]
},
{
"path": "Practitioner.qualification",
"short": "Qualifications obtained by training and certification",
"definition": "Qualifications obtained by training and certification.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "CER?"
},
{
"identity": "rim",
"map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"
},
{
"identity": "servd",
"map": "./Qualifications"
}
]
},
{
"path": "Practitioner.qualification.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Practitioner.qualification.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Practitioner.qualification.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Practitioner.qualification.identifier",
"short": "An identifier for this qualification for the practitioner",
"definition": "An identifier that applies to this person's qualification in this role.",
"requirements": "Often, specific identities are assigned for the qualification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Practitioner.qualification.code",
"short": "Coded representation of the qualification",
"definition": "Coded representation of the qualification.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Qualification",
"strength": "example",
"description": "Specific qualification the practitioner has to provide a service",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/anzsco-occupations"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "./Qualifications.Value"
}
]
},
{
"path": "Practitioner.qualification.period",
"short": "Period during which the qualification is valid",
"definition": "Period during which the qualification is valid.",
"requirements": "Qualifications are often for a limited period of time, and can be revoked.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "./Qualifications.StartDate and ./Qualifications.EndDate"
}
]
},
{
"path": "Practitioner.qualification.issuer",
"short": "Organization that regulates and issues the qualification",
"definition": "Organization that regulates and issues the qualification.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "./scoper"
}
]
},
{
"path": "Practitioner.communication",
"short": "A language the practitioner is able to use in patient communication",
"definition": "A language the practitioner is able to use in patient communication.",
"comments": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements": "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Practitioner",
"short": "A person with a formal responsibility in the provisioning of healthcare or related services",
"definition": "A person who is directly or indirectly involved in the provisioning of healthcare.",
"comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?",
"requirements": "Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "rim",
"map": "Role"
},
{
"identity": "servd",
"map": "Provider"
}
]
},
{
"path": "Practitioner.identifier",
"short": "A identifier for the person as this agent",
"definition": "An identifier that applies to this person in this role.",
"requirements": "Often, specific identities are assigned for the agent.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRD-7 (or XCN.1 Person Identifier)"
},
{
"identity": "rim",
"map": "./id"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
},
{
"path": "Practitioner.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XCN Components"
},
{
"identity": "rim",
"map": "./name"
},
{
"identity": "servd",
"map": "./PreferredName (GivenNames, FamilyName, TitleCode)"
}
]
},
{
"path": "Practitioner.telecom",
"short": "A contact detail for the practitioner",
"definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "Need to know how to reach a practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT-15, STF-10, ROL-12"
},
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
},
{
"path": "Practitioner.address",
"short": "Where practitioner can be found/visited",
"definition": "The postal address where the practitioner can be found or visited or to which mail can be delivered.",
"requirements": "Need to keep track where the practitioner can found during work or for directing mail.",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "servd",
"map": "./Addresses"
}
]
},
{
"path": "Practitioner.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements": "Needed to address the person correctly.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "STF-5"
},
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "servd",
"map": "./GenderCode"
}
]
},
{
"path": "Practitioner.birthDate",
"short": "The date of birth for the practitioner",
"definition": "The date of birth for the practitioner.",
"requirements": "Needed for identification.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "STF-6"
},
{
"identity": "rim",
"map": "./birthTime"
},
{
"identity": "servd",
"map": "(not represented in ServD)"
}
]
},
{
"path": "Practitioner.photo",
"short": "Image of the person",
"definition": "Image of the person.",
"requirements": "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
]
},
{
"path": "Practitioner.practitionerRole",
"short": "The list of Roles/Organizations that the Practitioner is associated with",
"definition": "The list of Roles/Organizations that the Practitioner is associated with.",
"min": 0,
"max": "*"
},
{
"path": "Practitioner.practitionerRole.managingOrganization",
"short": "The Organization where the Practitioner performs the roles associated",
"definition": "The Organization where the Practitioner performs the roles associated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "Practitioner.practitionerRole.role",
"short": "Roles which this practitioner may perform",
"definition": "Roles which this practitioner is authorized to perform for the organization.",
"comments": "A person may have more than one role. At least one role is required.",
"requirements": "Need to know what authority the practitioner has - what can they do?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PractitionerRole",
"strength": "example",
"description": "The role a person plays representing an organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/practitioner-role"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRD-1 / STF-18-job title / PRA-3-practitioner category / PRT-4-Participation / ROL-3-role-ROL / ORC-12-ordering provider / OBR-16-ordering provider / PV1-7-attending doctor / PV1-8-referring doctor / PV1-9-consulting doctor / PV1-17-admitting doctor"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
},
{
"path": "Practitioner.practitionerRole.specialty",
"short": "Specific specialty of the practitioner",
"definition": "Specific specialty of the practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PractitionerSpecialty",
"strength": "example",
"description": "Specific specialty associated with the agency",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/practitioner-specialty"
}
},
"mapping": [
{
"identity": "v2",
"map": "PRA-5-specialty"
},
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "servd",
"map": "./Specialty"
}
]
},
{
"path": "Practitioner.practitionerRole.period",
"short": "The period during which the practitioner is authorized to perform in these role(s)",
"definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRD-8/9 / PRA-5.4-date of certification"
},
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
},
{
"path": "Practitioner.practitionerRole.location",
"short": "The location(s) at which this practitioner provides care",
"definition": "The location(s) at which this practitioner provides care.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/>\rHowever these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}
]
},
{
"path": "Practitioner.practitionerRole.healthcareService",
"short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)",
"definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/HealthcareService"
}
]
},
{
"path": "Practitioner.qualification",
"short": "Qualifications obtained by training and certification",
"definition": "Qualifications obtained by training and certification.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "v2",
"map": "CER?"
},
{
"identity": "rim",
"map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"
},
{
"identity": "servd",
"map": "./Qualifications"
}
]
},
{
"path": "Practitioner.qualification.identifier",
"short": "An identifier for this qualification for the practitioner",
"definition": "An identifier that applies to this person's qualification in this role.",
"requirements": "Often, specific identities are assigned for the qualification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "Practitioner.qualification.code",
"short": "Coded representation of the qualification",
"definition": "Coded representation of the qualification.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Qualification",
"strength": "example",
"description": "Specific qualification the practitioner has to provide a service",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/anzsco-occupations"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "./Qualifications.Value"
}
]
},
{
"path": "Practitioner.qualification.period",
"short": "Period during which the qualification is valid",
"definition": "Period during which the qualification is valid.",
"requirements": "Qualifications are often for a limited period of time, and can be revoked.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "./Qualifications.StartDate and ./Qualifications.EndDate"
}
]
},
{
"path": "Practitioner.qualification.issuer",
"short": "Organization that regulates and issues the qualification",
"definition": "Organization that regulates and issues the qualification.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "./scoper"
}
]
},
{
"path": "Practitioner.communication",
"short": "A language the practitioner is able to use in patient communication",
"definition": "A language the practitioner is able to use in patient communication.",
"comments": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements": "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Procedure",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Procedure",
"name": "Procedure",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Procedure Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Procedure",
"short": "An action that is performed on a patient",
"definition": "An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.",
"min": 1,
"max": "1",
"type": [
{
"code": "Procedure"
}
],
"mapping": [
{
"identity": "rim",
"map": "Procedure[moodCode=EVN]"
}
]
},
{
"path": "Procedure.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Procedure.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Procedure.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Procedure.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Procedure.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Procedure.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.identifier",
"short": "External Ids for this procedure",
"definition": "This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Procedure.patient",
"short": "Who procedure was performed on",
"definition": "The person on whom the procedure was performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "Procedure.status",
"short": "in-progress | aborted | completed | entered-in-error",
"definition": "A code specifying the state of the procedure record. Generally this will be in-progress or completed state.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureStatus",
"strength": "required",
"description": "A code specifying the state of the procedure record",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-status"
}
}
},
{
"path": "Procedure.category",
"short": "Classification of the procedure",
"definition": "A code that classifies the procedure for searching, sorting and display purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureCategory",
"strength": "example",
"description": "A code that classifies a procedure for searching, sorting and display purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Procedure.type",
"short": "Identification of the procedure",
"definition": "The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureType",
"strength": "example",
"description": "A code for a type of procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Procedure.bodySite",
"short": "Precise location details",
"definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "Procedure.bodySite.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.bodySite.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.bodySite.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.bodySite.site[x]",
"short": "Precise location details",
"definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"isSummary": true
},
{
"path": "Procedure.indication",
"short": "Reason procedure performed",
"definition": "The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.",
"comments": "e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapuetic.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "Procedure.performer",
"short": "The people who performed the procedure",
"definition": "Limited to 'real' people rather than equipment.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "Procedure.performer.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.performer.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.performer.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.performer.person",
"short": "The reference to the practitioner",
"definition": "The practitioner who was involved in the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Procedure.performer.role",
"short": "The role the person was in",
"definition": "E.g. surgeon, anaethetist, endoscopist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "Procedure.performed[x]",
"short": "Date/Period the procedure was performed",
"definition": "The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Procedure.encounter",
"short": "The encounter when procedure performed",
"definition": "The encounter during which the procedure was performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Procedure.location",
"short": "Where the procedure happened",
"definition": "The location where the procedure actually happened. e.g. a newborn at home, a tracheostomy at a restaurant.",
"comments": "Ties a procedure to where the records are kept.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true
},
{
"path": "Procedure.outcome",
"short": "What was result of procedure?",
"definition": "What was the outcome of the procedure - did it resolve reasons why the procedure was performed?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureOutcome",
"strength": "example",
"description": "The outcome of a procedure - whether it resolveed the reasons why the procedure was performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
}
]
},
{
"path": "Procedure.report",
"short": "Any report that results from the procedure",
"definition": "This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Procedure.complication",
"short": "Complication following the procedure",
"definition": "Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": "Need specialization of OUT for this."
}
]
},
{
"path": "Procedure.followUp",
"short": "Instructions for follow up",
"definition": "If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ProcedureFollowUp",
"strength": "example",
"description": "Specific follow up required for a procedure e.g. removal of sutures",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-followup"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code"
}
]
},
{
"path": "Procedure.relatedItem",
"short": "A procedure that is related to this one",
"definition": "Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=TRIG and target[classCode=PROC, moodCode=EVN]]"
}
]
},
{
"path": "Procedure.relatedItem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.relatedItem.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.relatedItem.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.relatedItem.type",
"short": "caused-by | because-of",
"definition": "The nature of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProcedureRelationshipType",
"strength": "required",
"description": "The nature of the relationship with this procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inversionInd"
}
]
},
{
"path": "Procedure.relatedItem.target",
"short": "The related item - e.g. a procedure",
"definition": "The related item - e.g. a procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyHistory"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationDispense"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"mapping": [
{
"identity": "rim",
"map": ".target"
}
]
},
{
"path": "Procedure.notes",
"short": "Additional information about procedure",
"definition": "Any other notes about the procedure - e.g. the operative notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Procedure.device",
"short": "Device changed in procedure",
"definition": "A device change during the procedure.",
"min": 0,
"max": "*"
},
{
"path": "Procedure.device.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.device.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Procedure.device.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Procedure.device.action",
"short": "Kind of change to device",
"definition": "The kind of change that happened to the device during the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DeviceActionKind",
"strength": "required",
"description": "The kind of change that happened to the device during the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-action"
}
}
},
{
"path": "Procedure.device.manipulated",
"short": "Device that was changed",
"definition": "The device that was manipulated (changed) during the procedure.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Procedure",
"short": "An action that is performed on a patient",
"definition": "An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Procedure[moodCode=EVN]"
}
]
},
{
"path": "Procedure.identifier",
"short": "External Ids for this procedure",
"definition": "This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Procedure.patient",
"short": "Who procedure was performed on",
"definition": "The person on whom the procedure was performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "Procedure.status",
"short": "in-progress | aborted | completed | entered-in-error",
"definition": "A code specifying the state of the procedure record. Generally this will be in-progress or completed state.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureStatus",
"strength": "required",
"description": "A code specifying the state of the procedure record",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-status"
}
}
},
{
"path": "Procedure.category",
"short": "Classification of the procedure",
"definition": "A code that classifies the procedure for searching, sorting and display purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureCategory",
"strength": "example",
"description": "A code that classifies a procedure for searching, sorting and display purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"
}
]
},
{
"path": "Procedure.type",
"short": "Identification of the procedure",
"definition": "The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureType",
"strength": "example",
"description": "A code for a type of procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Procedure.bodySite",
"short": "Precise location details",
"definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"path": "Procedure.bodySite.site[x]",
"short": "Precise location details",
"definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"isSummary": true
},
{
"path": "Procedure.indication",
"short": "Reason procedure performed",
"definition": "The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.",
"comments": "e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapuetic.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"path": "Procedure.performer",
"short": "The people who performed the procedure",
"definition": "Limited to 'real' people rather than equipment.",
"min": 0,
"max": "*",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"path": "Procedure.performer.person",
"short": "The reference to the practitioner",
"definition": "The practitioner who was involved in the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".role"
}
]
},
{
"path": "Procedure.performer.role",
"short": "The role the person was in",
"definition": "E.g. surgeon, anaethetist, endoscopist.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".functionCode"
}
]
},
{
"path": "Procedure.performed[x]",
"short": "Date/Period the procedure was performed",
"definition": "The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Procedure.encounter",
"short": "The encounter when procedure performed",
"definition": "The encounter during which the procedure was performed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "Procedure.location",
"short": "Where the procedure happened",
"definition": "The location where the procedure actually happened. e.g. a newborn at home, a tracheostomy at a restaurant.",
"comments": "Ties a procedure to where the records are kept.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"isSummary": true
},
{
"path": "Procedure.outcome",
"short": "What was result of procedure?",
"definition": "What was the outcome of the procedure - did it resolve reasons why the procedure was performed?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ProcedureOutcome",
"strength": "example",
"description": "The outcome of a procedure - whether it resolveed the reasons why the procedure was performed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
}
]
},
{
"path": "Procedure.report",
"short": "Any report that results from the procedure",
"definition": "This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "Procedure.complication",
"short": "Complication following the procedure",
"definition": "Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": "Need specialization of OUT for this."
}
]
},
{
"path": "Procedure.followUp",
"short": "Instructions for follow up",
"definition": "If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "ProcedureFollowUp",
"strength": "example",
"description": "Specific follow up required for a procedure e.g. removal of sutures",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-followup"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code"
}
]
},
{
"path": "Procedure.relatedItem",
"short": "A procedure that is related to this one",
"definition": "Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=TRIG and target[classCode=PROC, moodCode=EVN]]"
}
]
},
{
"path": "Procedure.relatedItem.type",
"short": "caused-by | because-of",
"definition": "The nature of the relationship.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProcedureRelationshipType",
"strength": "required",
"description": "The nature of the relationship with this procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-relationship-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inversionInd"
}
]
},
{
"path": "Procedure.relatedItem.target",
"short": "The related item - e.g. a procedure",
"definition": "The related item - e.g. a procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/FamilyHistory"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImagingStudy"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationDispense"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationPrescription"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationStatement"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Observation"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"mapping": [
{
"identity": "rim",
"map": ".target"
}
]
},
{
"path": "Procedure.notes",
"short": "Additional information about procedure",
"definition": "Any other notes about the procedure - e.g. the operative notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Procedure.device",
"short": "Device changed in procedure",
"definition": "A device change during the procedure.",
"min": 0,
"max": "*"
},
{
"path": "Procedure.device.action",
"short": "Kind of change to device",
"definition": "The kind of change that happened to the device during the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DeviceActionKind",
"strength": "required",
"description": "The kind of change that happened to the device during the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/device-action"
}
}
},
{
"path": "Procedure.device.manipulated",
"short": "Device that was changed",
"definition": "The device that was manipulated (changed) during the procedure.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ProcedureRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest",
"name": "ProcedureRequest",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ProcedureRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "quick",
"uri": "http://wiki.siframework.org/CQF",
"name": "Quality Improvement and Clinical Knowledge (QUICK)"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ProcedureRequest",
"short": "A request for a procedure to be performed",
"definition": "A request for a procedure to be performed. May be a proposal or an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "ProcedureRequest"
}
]
},
{
"path": "ProcedureRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ProcedureRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ProcedureRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ProcedureRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ProcedureRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ProcedureRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcedureRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcedureRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcedureRequest.identifier",
"short": "Identifier",
"definition": "Identifiers assigned to this order by the order or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "ProcedureRequest.subject",
"short": "Subject",
"definition": "The patient who will receive the procedure.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "ProcedureRequest.type",
"short": "Procedure Type",
"definition": "The specific procedure that is ordered. Use text if the exact nature of the procedure can't be coded.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Procedure.procedureCode"
}
]
},
{
"path": "ProcedureRequest.bodySite",
"short": "Target body sites",
"definition": "Indicates the sites on the subject's body where the procedure should be performed ( i.e. the target sites).",
"comments": "Only used if not implicit in code found in ProcedureRequest.type.",
"requirements": "Knowing where the procedure is made is important for tracking if multiple sites are possible.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "quick",
"map": "Procedure.targetBodySite"
},
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "ProcedureRequest.bodySite.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcedureRequest.bodySite.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcedureRequest.bodySite.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcedureRequest.bodySite.site[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the procedure should be performed ( i.e. the target sites).",
"comments": "Only used if not implicit in code found in ProcedureRequest.type.",
"requirements": "Knowing where the procedure is made is important for tracking if multiple site are possible.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
]
},
{
"path": "ProcedureRequest.indication",
"short": "Indication",
"definition": "The reason why the procedure is proposed or ordered. This procedure request may be motivated by a Condition for instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "ProcedureRequest.timing[x]",
"short": "Procedure timing schedule",
"definition": "The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "quick",
"map": "Procedure.procedureSchedule"
}
]
},
{
"path": "ProcedureRequest.encounter",
"short": "Encounter",
"definition": "The encounter within which the procedure proposal or request was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.encounter"
}
]
},
{
"path": "ProcedureRequest.performer",
"short": "Performer",
"definition": "E.g. surgeon, anaethetist, endoscopist.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "ProcedureRequest.status",
"short": "proposed | draft | requested | received | accepted | in-progress | completed | suspended | rejected | aborted",
"definition": "The status of the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ProcedureRequestStatus",
"strength": "required",
"description": "The status of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-request-status"
}
},
"mapping": [
{
"identity": "quick",
"map": "Action.currentStatus"
}
]
},
{
"path": "ProcedureRequest.notes",
"short": "Notes",
"definition": "Any other notes associated with this proposal or order - e.g., provider instructions.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "ProcedureRequest.asNeeded[x]",
"short": "PRN",
"definition": "If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.prnReason.reason"
}
]
},
{
"path": "ProcedureRequest.orderedOn",
"short": "When Requested",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.proposedAtTime"
}
]
},
{
"path": "ProcedureRequest.orderer",
"short": "Ordering Party",
"definition": "The healthcare professional responsible for proposing or ordering the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementAuthor"
}
]
},
{
"path": "ProcedureRequest.priority",
"short": "routine | urgent | stat | asap",
"definition": "The clinical priority associated with this order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProcedureRequestPriority",
"strength": "required",
"description": "The priority of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-request-priority"
}
},
"mapping": [
{
"identity": "quick",
"map": "Proposal.urgency"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ProcedureRequest",
"short": "A request for a procedure to be performed",
"definition": "A request for a procedure to be performed. May be a proposal or an order.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ProcedureRequest.identifier",
"short": "Identifier",
"definition": "Identifiers assigned to this order by the order or by the receiver.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.identifier"
}
]
},
{
"path": "ProcedureRequest.subject",
"short": "Subject",
"definition": "The patient who will receive the procedure.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.subject"
}
]
},
{
"path": "ProcedureRequest.type",
"short": "Procedure Type",
"definition": "The specific procedure that is ordered. Use text if the exact nature of the procedure can't be coded.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Procedure.procedureCode"
}
]
},
{
"path": "ProcedureRequest.bodySite",
"short": "Target body sites",
"definition": "Indicates the sites on the subject's body where the procedure should be performed ( i.e. the target sites).",
"comments": "Only used if not implicit in code found in ProcedureRequest.type.",
"requirements": "Knowing where the procedure is made is important for tracking if multiple sites are possible.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "quick",
"map": "Procedure.targetBodySite"
},
{
"identity": "rim",
"map": "targetSiteCode"
}
]
},
{
"path": "ProcedureRequest.bodySite.site[x]",
"short": "Target body site",
"definition": "Indicates the site on the subject's body where the procedure should be performed ( i.e. the target sites).",
"comments": "Only used if not implicit in code found in ProcedureRequest.type.",
"requirements": "Knowing where the procedure is made is important for tracking if multiple site are possible.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
]
},
{
"path": "ProcedureRequest.indication",
"short": "Indication",
"definition": "The reason why the procedure is proposed or ordered. This procedure request may be motivated by a Condition for instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Action.indication.reason"
}
]
},
{
"path": "ProcedureRequest.timing[x]",
"short": "Procedure timing schedule",
"definition": "The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Timing"
}
],
"mapping": [
{
"identity": "quick",
"map": "Procedure.procedureSchedule"
}
]
},
{
"path": "ProcedureRequest.encounter",
"short": "Encounter",
"definition": "The encounter within which the procedure proposal or request was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.encounter"
}
]
},
{
"path": "ProcedureRequest.performer",
"short": "Performer",
"definition": "E.g. surgeon, anaethetist, endoscopist.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
]
},
{
"path": "ProcedureRequest.status",
"short": "proposed | draft | requested | received | accepted | in-progress | completed | suspended | rejected | aborted",
"definition": "The status of the order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ProcedureRequestStatus",
"strength": "required",
"description": "The status of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-request-status"
}
},
"mapping": [
{
"identity": "quick",
"map": "Action.currentStatus"
}
]
},
{
"path": "ProcedureRequest.notes",
"short": "Notes",
"definition": "Any other notes associated with this proposal or order - e.g., provider instructions.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.additionalText"
}
]
},
{
"path": "ProcedureRequest.asNeeded[x]",
"short": "PRN",
"definition": "If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.prnReason.reason"
}
]
},
{
"path": "ProcedureRequest.orderedOn",
"short": "When Requested",
"definition": "The time when the request was made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "quick",
"map": "Proposal.proposedAtTime"
}
]
},
{
"path": "ProcedureRequest.orderer",
"short": "Ordering Party",
"definition": "The healthcare professional responsible for proposing or ordering the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "quick",
"map": "ClinicalStatement.statementAuthor"
}
]
},
{
"path": "ProcedureRequest.priority",
"short": "routine | urgent | stat | asap",
"definition": "The clinical priority associated with this order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProcedureRequestPriority",
"strength": "required",
"description": "The priority of the request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/procedure-request-priority"
}
},
"mapping": [
{
"identity": "quick",
"map": "Proposal.urgency"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ProcessRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ProcessRequest",
"name": "ProcessRequest",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ProcessRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ProcessRequest",
"short": "Process request",
"definition": "This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "ProcessRequest"
}
]
},
{
"path": "ProcessRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ProcessRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ProcessRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ProcessRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ProcessRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ProcessRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessRequest.action",
"short": "cancel | poll | reprocess | status",
"definition": "The type of procesing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ActionList",
"strength": "required",
"description": "List of allowable action which this resource can request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/actionlist"
}
}
},
{
"path": "ProcessRequest.identifier",
"short": "Business Identifier",
"definition": "The ProcessRequest Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ProcessRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ProcessRequest.target",
"short": "Target of the request",
"definition": "The organization which is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the action specified in thise request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ProcessRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the action speccified in thise request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessRequest.request",
"short": "Request reference",
"definition": "Reference of resource which is the target or subject of this action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "ProcessRequest.response",
"short": "Response reference",
"definition": "Reference of a prior response to resource which is the target or subject of this action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "ProcessRequest.nullify",
"short": "Nullify",
"definition": "If true remove all history excluding audit.",
"requirements": "Some resources must not simply be reversed in a processing or accounting sense but rather must have all history removed, such as the accidental submission of sensitive and/or wrong information. If the receiver cannot comply with a Nullify request then they must reject the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ProcessRequest.reference",
"short": "Reference number/string",
"definition": "A reference to supply which authenticates the process.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.item",
"short": "Items to re-adjudicate",
"definition": "List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.",
"min": 0,
"max": "*"
},
{
"path": "ProcessRequest.item.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcessRequest.item.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcessRequest.item.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessRequest.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ProcessRequest.include",
"short": "Resource type(s) to include",
"definition": "Names of resource types to include.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.exclude",
"short": "Resource type(s) to exclude",
"definition": "Names of resource types to exclude.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.period",
"short": "Period",
"definition": "A period of time during which the fulfilling resources would have been created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
},
"differential": {
"element": [
{
"path": "ProcessRequest",
"short": "Process request",
"definition": "This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ProcessRequest.action",
"short": "cancel | poll | reprocess | status",
"definition": "The type of procesing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ActionList",
"strength": "required",
"description": "List of allowable action which this resource can request",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/actionlist"
}
}
},
{
"path": "ProcessRequest.identifier",
"short": "Business Identifier",
"definition": "The ProcessRequest Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ProcessRequest.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessRequest.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessRequest.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ProcessRequest.target",
"short": "Target of the request",
"definition": "The organization which is target of the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessRequest.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the action specified in thise request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ProcessRequest.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the action speccified in thise request.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessRequest.request",
"short": "Request reference",
"definition": "Reference of resource which is the target or subject of this action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "ProcessRequest.response",
"short": "Response reference",
"definition": "Reference of a prior response to resource which is the target or subject of this action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"path": "ProcessRequest.nullify",
"short": "Nullify",
"definition": "If true remove all history excluding audit.",
"requirements": "Some resources must not simply be reversed in a processing or accounting sense but rather must have all history removed, such as the accidental submission of sensitive and/or wrong information. If the receiver cannot comply with a Nullify request then they must reject the request.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "ProcessRequest.reference",
"short": "Reference number/string",
"definition": "A reference to supply which authenticates the process.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.item",
"short": "Items to re-adjudicate",
"definition": "List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.",
"min": 0,
"max": "*"
},
{
"path": "ProcessRequest.item.sequenceLinkId",
"short": "Service instance",
"definition": "A service line number.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "ProcessRequest.include",
"short": "Resource type(s) to include",
"definition": "Names of resource types to include.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.exclude",
"short": "Resource type(s) to exclude",
"definition": "Names of resource types to exclude.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessRequest.period",
"short": "Period",
"definition": "A period of time during which the fulfilling resources would have been created.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ProcessResponse",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ProcessResponse",
"name": "ProcessResponse",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ProcessResponse Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ProcessResponse",
"short": "ProcessResponse resource",
"definition": "This resource provides processing status, errors and notes from the processing of a resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "ProcessResponse"
}
]
},
{
"path": "ProcessResponse.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ProcessResponse.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ProcessResponse.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ProcessResponse.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ProcessResponse.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ProcessResponse.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessResponse.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ProcessResponse.request",
"short": "Request reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ProcessResponse.outcome",
"short": "Processing outcome",
"definition": "Transaction status: error, complete, held.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProcessingOutcome",
"strength": "example",
"description": "Local status of outcome codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/process-outcome"
}
}
},
{
"path": "ProcessResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication or processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ProcessResponse.organization",
"short": "Authoring Organization",
"definition": "The organization who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessResponse.requestProvider",
"short": "Responsible Practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ProcessResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ProcessResponse.notes",
"short": "Notes",
"definition": "Suite of processing note or additional requirements is the processing has been held.",
"min": 0,
"max": "*"
},
{
"path": "ProcessResponse.notes.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcessResponse.notes.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ProcessResponse.notes.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ProcessResponse.notes.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ProcessResponse.notes.text",
"short": "Notes text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
},
{
"path": "ProcessResponse.error",
"short": "Error code",
"definition": "Processing errors.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"strength": "required",
"description": "The error codes for adjudication processing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
}
]
},
"differential": {
"element": [
{
"path": "ProcessResponse",
"short": "ProcessResponse resource",
"definition": "This resource provides processing status, errors and notes from the processing of a resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ProcessResponse.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "ProcessResponse.request",
"short": "Request reference",
"definition": "Original request resource reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02|G01"
}
]
},
{
"path": "ProcessResponse.outcome",
"short": "Processing outcome",
"definition": "Transaction status: error, complete, held.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProcessingOutcome",
"strength": "example",
"description": "Local status of outcome codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/process-outcome"
}
}
},
{
"path": "ProcessResponse.disposition",
"short": "Disposition Message",
"definition": "A description of the status of the adjudication or processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ProcessResponse.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessResponse.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "ProcessResponse.created",
"short": "Creation date",
"definition": "The date when the enclosed suite of services were performed or completed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "ProcessResponse.organization",
"short": "Authoring Organization",
"definition": "The organization who produced this adjudicated response.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessResponse.requestProvider",
"short": "Responsible Practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "ProcessResponse.requestOrganization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "ProcessResponse.form",
"short": "Printed Form Identifier",
"definition": "The form to be used for printing the content.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Forms",
"strength": "required",
"description": "The forms codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/forms"
}
},
"mapping": [
{
"identity": "cdanetv4",
"map": "G42"
}
]
},
{
"path": "ProcessResponse.notes",
"short": "Notes",
"definition": "Suite of processing note or additional requirements is the processing has been held.",
"min": 0,
"max": "*"
},
{
"path": "ProcessResponse.notes.type",
"short": "display | print | printoper",
"definition": "The note purpose: Print/Display.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "NoteType",
"strength": "required",
"description": "The presentation types of notes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/NT-link"
}
}
},
{
"path": "ProcessResponse.notes.text",
"short": "Notes text",
"definition": "The note text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G32"
}
]
},
{
"path": "ProcessResponse.error",
"short": "Error code",
"definition": "Processing errors.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "AdjudicationError",
"strength": "required",
"description": "The error codes for adjudication processing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/adjudication-error"
}
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Provenance",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Provenance",
"name": "Provenance",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Provenance Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "w3c.prov",
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Provenance",
"short": "Who, What, When for a set of resources",
"definition": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g., Document Completion - has the artifact been legally authenticated), all of which may impact Security, Privacy, and Trust policies.",
"comments": "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.",
"alias": [
"History",
"Event",
"Activity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Provenance"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
},
{
"identity": "w3c.prov",
"map": "Activity"
}
]
},
{
"path": "Provenance.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Provenance.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Provenance.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Provenance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Provenance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Provenance.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Provenance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Provenance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Provenance.target",
"short": "Target Reference(s) (usually version specific)",
"definition": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
"comments": "Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target\r\rOR\r\r./participation[isNormalParticipation() and typeCode=SBJ]/role\r\rOR\r\r./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
},
{
"identity": "w3c.prov",
"map": "Entity Created/Updated"
}
]
},
{
"path": "Provenance.period",
"short": "When the activity occurred",
"definition": "The period during which the activity occurred.",
"comments": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime[type=IVL_TS]"
},
{
"identity": "w3c.prov",
"map": "Activity.startTime & Activity.endTime"
}
]
},
{
"path": "Provenance.recorded",
"short": "When the activity was recorded / updated",
"definition": "The instant of time at which the activity was recorded.",
"comments": "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
}
]
},
{
"path": "Provenance.reason",
"short": "Reason the activity is occurring",
"definition": "The reason that the activity was taking place.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./reasonCode)"
},
{
"identity": "w3c.prov",
"map": "Activity.Activity"
}
]
},
{
"path": "Provenance.location",
"short": "Where the activity occurred, if relevant",
"definition": "Where the activity occurred, if relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
},
{
"identity": "w3c.prov",
"map": "Activity.location"
}
]
},
{
"path": "Provenance.policy",
"short": "Policy or plan the activity was defined by",
"definition": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
}
]
},
{
"path": "Provenance.agent",
"name": "agent",
"short": "Agents involved in creating resource",
"definition": "An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.",
"comments": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./participation[isNormalParticipation()]\r\rOR\r\r./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
},
{
"identity": "w3c.prov",
"map": "Agent"
}
]
},
{
"path": "Provenance.agent.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Provenance.agent.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Provenance.agent.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Provenance.agent.role",
"short": "Agents Role",
"definition": "The function of the agent with respect to the activity.",
"comments": "e.g. author | performer | enterer | attester: +.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceAgentRole",
"strength": "extensible",
"description": "The role that a provenance agent played with respect to the activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "attester: .[self::participation]/typeCode='RESP'\rauthor: .[self::participation]/typeCode='AUT'\rcc: .[self::participation]/typeCode='IRCP'\renterer: .[self::participation]/typeCode='ENT'\rinformant: .[self::participation]/typeCode='INF'\rperformer: .[self::participation]/typeCode='PRF'\rverifier: .[self::participation]/typeCode='VRF'\rsource: .[self::outboundRelationship]/typeCode=''"
},
{
"identity": "w3c.prov",
"map": "Agent.Attribution"
}
]
},
{
"path": "Provenance.agent.type",
"short": "Agent Type",
"definition": "The type of participation of the agent.",
"comments": "e.g. Person | Application | Patient | Device +.",
"requirements": "If the type is \"Resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceAgentType",
"strength": "required",
"description": "The type of a provenance agent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST']\ragent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormalEntity and classCode='PSN' and determinerCode='INST']]\rorganization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST']\r\rsoftware: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEntity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')]\rdocument: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"
},
{
"identity": "w3c.prov",
"map": "Agent.Association"
}
]
},
{
"path": "Provenance.agent.reference[x]",
"short": "Identity of agent",
"definition": "Identity of participant as a Resource or uri.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "w3c.prov",
"map": "Agent.Identity"
}
]
},
{
"path": "Provenance.agent.display",
"short": "Human description of participant",
"definition": "Human-readable description of the participant.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./player/description\r\rOR\r\r./description\r\rOR\r\r./text"
},
{
"identity": "w3c.prov",
"map": "Agent.label"
}
]
},
{
"path": "Provenance.entity",
"short": "An entity used in this activity",
"definition": "An entity used in this activity.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./subjectOf"
},
{
"identity": "w3c.prov",
"map": "Entity"
}
]
},
{
"path": "Provenance.entity.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Provenance.entity.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Provenance.entity.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Provenance.entity.role",
"short": "derivation | revision | quotation | source",
"definition": "How the entity was used during the activity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProvenanceEntityRole",
"strength": "required",
"description": "How an entity was used in an activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-entity-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "./typeCode"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
}
]
},
{
"path": "Provenance.entity.type",
"short": "Entity Type",
"definition": "The type of the entity. If the entity is a resource, then this is a resource type.",
"requirements": "If the type is \"resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceEntityType",
"strength": "required",
"description": "The type of an entity used in an activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
},
"mapping": [
{
"identity": "rim",
"map": "./target"
},
{
"identity": "w3c.prov",
"map": "Entity.type"
}
]
},
{
"path": "Provenance.entity.reference",
"short": "Identity of entity",
"definition": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"comments": "identity may be a reference to a resource or to something else, depending on the type.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "./text/reference"
},
{
"identity": "w3c.prov",
"map": "Entity.Identity"
}
]
},
{
"path": "Provenance.entity.display",
"short": "Human description of entity",
"definition": "Human-readable description of the entity.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./title"
},
{
"identity": "w3c.prov",
"map": "Entity.Label"
}
]
},
{
"path": "Provenance.entity.agent",
"short": "Entity is attributed to this agent",
"definition": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"min": 0,
"max": "1",
"nameReference": "agent",
"mapping": [
{
"identity": "rim",
"map": "./author/role"
}
]
},
{
"path": "Provenance.signature",
"short": "Signature on target",
"definition": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Signature"
}
],
"mapping": [
{
"identity": "rim",
"map": "./signatureText"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Provenance",
"short": "Who, What, When for a set of resources",
"definition": "Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g., Document Completion - has the artifact been legally authenticated), all of which may impact Security, Privacy, and Trust policies.",
"comments": "Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance.",
"alias": [
"History",
"Event",
"Activity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
},
{
"identity": "w3c.prov",
"map": "Activity"
}
]
},
{
"path": "Provenance.target",
"short": "Target Reference(s) (usually version specific)",
"definition": "The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.",
"comments": "Target references are usually version specific, but may not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource may not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion.",
"min": 1,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target\r\rOR\r\r./participation[isNormalParticipation() and typeCode=SBJ]/role\r\rOR\r\r./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
},
{
"identity": "w3c.prov",
"map": "Entity Created/Updated"
}
]
},
{
"path": "Provenance.period",
"short": "When the activity occurred",
"definition": "The period during which the activity occurred.",
"comments": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime[type=IVL_TS]"
},
{
"identity": "w3c.prov",
"map": "Activity.startTime & Activity.endTime"
}
]
},
{
"path": "Provenance.recorded",
"short": "When the activity was recorded / updated",
"definition": "The instant of time at which the activity was recorded.",
"comments": "This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
}
]
},
{
"path": "Provenance.reason",
"short": "Reason the activity is occurring",
"definition": "The reason that the activity was taking place.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./reasonCode)"
},
{
"identity": "w3c.prov",
"map": "Activity.Activity"
}
]
},
{
"path": "Provenance.location",
"short": "Where the activity occurred, if relevant",
"definition": "Where the activity occurred, if relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
},
{
"identity": "w3c.prov",
"map": "Activity.location"
}
]
},
{
"path": "Provenance.policy",
"short": "Policy or plan the activity was defined by",
"definition": "Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
}
]
},
{
"path": "Provenance.agent",
"name": "agent",
"short": "Agents involved in creating resource",
"definition": "An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility.",
"comments": "Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./participation[isNormalParticipation()]\r\rOR\r\r./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
},
{
"identity": "w3c.prov",
"map": "Agent"
}
]
},
{
"path": "Provenance.agent.role",
"short": "Agents Role",
"definition": "The function of the agent with respect to the activity.",
"comments": "e.g. author | performer | enterer | attester: +.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceAgentRole",
"strength": "extensible",
"description": "The role that a provenance agent played with respect to the activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "attester: .[self::participation]/typeCode='RESP'\rauthor: .[self::participation]/typeCode='AUT'\rcc: .[self::participation]/typeCode='IRCP'\renterer: .[self::participation]/typeCode='ENT'\rinformant: .[self::participation]/typeCode='INF'\rperformer: .[self::participation]/typeCode='PRF'\rverifier: .[self::participation]/typeCode='VRF'\rsource: .[self::outboundRelationship]/typeCode=''"
},
{
"identity": "w3c.prov",
"map": "Agent.Attribution"
}
]
},
{
"path": "Provenance.agent.type",
"short": "Agent Type",
"definition": "The type of participation of the agent.",
"comments": "e.g. Person | Application | Patient | Device +.",
"requirements": "If the type is \"Resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceAgentType",
"strength": "required",
"description": "The type of a provenance agent",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-agent-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST']\ragent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormalEntity and classCode='PSN' and determinerCode='INST']]\rorganization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST']\r\rsoftware: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEntity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')]\rdocument: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"
},
{
"identity": "w3c.prov",
"map": "Agent.Association"
}
]
},
{
"path": "Provenance.agent.reference[x]",
"short": "Identity of agent",
"definition": "Identity of participant as a Resource or uri.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "w3c.prov",
"map": "Agent.Identity"
}
]
},
{
"path": "Provenance.agent.display",
"short": "Human description of participant",
"definition": "Human-readable description of the participant.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./player/description\r\rOR\r\r./description\r\rOR\r\r./text"
},
{
"identity": "w3c.prov",
"map": "Agent.label"
}
]
},
{
"path": "Provenance.entity",
"short": "An entity used in this activity",
"definition": "An entity used in this activity.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "./subjectOf"
},
{
"identity": "w3c.prov",
"map": "Entity"
}
]
},
{
"path": "Provenance.entity.role",
"short": "derivation | revision | quotation | source",
"definition": "How the entity was used during the activity.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ProvenanceEntityRole",
"strength": "required",
"description": "How an entity was used in an activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/provenance-entity-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "./typeCode"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
}
]
},
{
"path": "Provenance.entity.type",
"short": "Entity Type",
"definition": "The type of the entity. If the entity is a resource, then this is a resource type.",
"requirements": "If the type is \"resource\" then the resource itself was the participant. If the type is a type of resource, then the entity identified by the resource is the participant.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "ProvenanceEntityType",
"strength": "required",
"description": "The type of an entity used in an activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
},
"mapping": [
{
"identity": "rim",
"map": "./target"
},
{
"identity": "w3c.prov",
"map": "Entity.type"
}
]
},
{
"path": "Provenance.entity.reference",
"short": "Identity of entity",
"definition": "Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.",
"comments": "identity may be a reference to a resource or to something else, depending on the type.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "./text/reference"
},
{
"identity": "w3c.prov",
"map": "Entity.Identity"
}
]
},
{
"path": "Provenance.entity.display",
"short": "Human description of entity",
"definition": "Human-readable description of the entity.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./title"
},
{
"identity": "w3c.prov",
"map": "Entity.Label"
}
]
},
{
"path": "Provenance.entity.agent",
"short": "Entity is attributed to this agent",
"definition": "The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.",
"min": 0,
"max": "1",
"nameReference": "agent",
"mapping": [
{
"identity": "rim",
"map": "./author/role"
}
]
},
{
"path": "Provenance.signature",
"short": "Signature on target",
"definition": "A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Signature"
}
],
"mapping": [
{
"identity": "rim",
"map": "./signatureText"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "Questionnaire-populate",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/Questionnaire-populate",
"name": "Populate Questionnaire",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Generates a [[[QuestionnaireAnswers]]] instance based on a specified [[[Questionnaire]]], filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the [[[Questionnaire]]].\n\nIf the operation is not called at the instance level, one of the identifier or questionnaire 'in' parameters must be provided. (If called at the instance level, these parameters will be ignored.)\n\nThe response will contain a [[[QuestionnaireAnswers]]] instance based on the specified [[[Questionnaire]]] and/or an [[[OperationOutcome]]] resource with errors or warnings.\n\nThe [[[QuestionnaireAnswers]]] instance will be populated with an unanswered set of questions following the group and question structure of the specified [[[Questionnaire]]]. If *content* parameters were specified or the *local* parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions.\n\nPopulation of the [[[QuestionnaireAnswers]]] with appropriate data is dependent on the questions and/or groups in the [[[Questionnaire]]] having metadata that allows the server to recognize the questions. This might be through *Questionnaire.group.question.code*, through extensions such as the [[http://hl7.org/fhir/StructureDefinition/questionnaire-deReference|deReference]] extension or through us of the [[ConceptMap]] resource.\n\nRegardless of the mechanism used to link the questions in a questionnaire to a \"known\" mapable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population. I.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertable, etc.",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "populate",
"notes": "While it is theoretically possible for a [[[QuestionnaireAnswers]]] instance to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. A client **SHOULD** ensure that a human submitter has an opportunity to review the auto-populated answers to confirm correctness as well as to complete or expand on information provided by the auto-population process.\n\nComplex form designs with conditional logic or tight constraints on cardinalities may be challenging to auto-populate. A server MAY choose to traverse the questionnaire as if it were a human respondant, answering only those questions that are enabled based on previously answered questions. However doing so may result in minimal population. Alternatively, systems may choose to populate all known answers, independent of dependencies and other constraints. This may cause questions to be answered that should not be answered. It will be up to the client to appropriately prune the final populated questionnaire once human review has taken place.\n\nInvoking this operation with the ''content'' parameter may involve the disclosure of personally identifiable healthcare information to the system which is performing the population process. No such disclosures should be made unless the system on which the operation is being invoked is a \"trusted\" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.",
"system": false,
"type": [
"Questionnaire"
],
"instance": true,
"parameter": [
{
"name": "identifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories.",
"type": "uri"
},
{
"name": "questionnaire",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The [[[Questionnaire]]] is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion",
"type": "Questionnaire"
},
{
"name": "subject",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The resource that is to be the *QuestionnaireAnswers.subject*. The [[[QuestionnaireAnswers]]] instance will reference the provided subject. In addition, if the *local* parameter is set to true, server information about the specified subject will be used to populate the instance.",
"type": "Any"
},
{
"name": "content",
"use": "in",
"min": 0,
"max": "*",
"documentation": "Resources containing information to be used to help populate the [[[QuestionnaireAnswers]]]. These may be FHIR resources or may be Binaries containing FHIR documents, CDA documents or other source materials. Servers may not support all possible source materials and may ignore materials they do not recognize. (They MAY provide warnings if ignoring submitted resources.)",
"type": "string"
},
{
"name": "local",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If specified and set to 'true' (and the server is capable), the server should use what resources and other knowledge it has about the referenced subject when pre-populating answers to questions.",
"type": "boolean"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The partially (or fully)-populated set of answers for the specified Questionnaire",
"type": "QuestionnaireAnswers"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Questionnaire",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"name": "Questionnaire",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Questionnaire Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Questionnaire",
"short": "A structured set of questions",
"definition": "A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.",
"alias": [
"Form",
"CRF",
"Survey"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Questionnaire"
}
],
"constraint": [
{
"key": "que-2",
"name": "UniqueLinkIds",
"severity": "error",
"human": "The link ids for groups and questions must be unique within the questionnaire",
"xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Questionnaire.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Questionnaire.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Questionnaire.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Questionnaire.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Questionnaire.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.identifier",
"short": "External Ids for this questionnaire",
"definition": "This records identifiers associated with this question set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=BUS]"
}
]
},
{
"path": "Questionnaire.version",
"short": "Logical id for this version of Questionnaire",
"definition": "The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.",
"requirements": "In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).",
"alias": [
"N/A - MIF rather than RIM level"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=VER]"
}
]
},
{
"path": "Questionnaire.status",
"short": "draft | published | retired",
"definition": "The lifecycle status of the questionnaire as a whole.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "QuestionnaireStatus",
"strength": "required",
"description": "Lifecycle status of the questionnaire",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/questionnaire-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}
]
},
{
"path": "Questionnaire.date",
"short": "Date this version was authored",
"definition": "The date that this questionnaire was last changed.",
"alias": [
"Date Created",
"Date published",
"Date Issued",
"Date updated"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Questionnaire.publisher",
"short": "Organization/individual who designed the questionnaire",
"definition": "Organization or person responsible for developing and maintaining the questionnaire.",
"requirements": "Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's \"authority\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Questionnaire.telecom",
"short": "Contact information of the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role.telecom"
}
]
},
{
"path": "Questionnaire.group",
"name": "group",
"short": "Grouped questions",
"definition": "A collection of related questions (or further groupings of questions).",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"alias": [
"Section"
],
"min": 1,
"max": "1",
"constraint": [
{
"key": "que-1",
"name": "GroupHaveSubOrQuestions",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
},
{
"path": "Questionnaire.group.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.group.linkId",
"short": "To link questionnaire with questionnaire answers",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireAnswers resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements": "[[[QuestionnaireAnswers]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.title",
"short": "Name to be displayed for group",
"definition": "The human-readable name for this section of the questionnaire.",
"comments": "The title of the \"root\" group is the title for the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "Questionnaire.group.concept",
"short": "Concept that represents this section on a questionnaire",
"definition": "Identifies a how this group of questions is known in a particular terminology such as LOINC.",
"comments": "The code(s) for the \"root\" group apply to the questionnaire as a whole.",
"requirements": "Allows linking of groups of questions (and complete questionnaires) to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "QuestionnaireGroupConcept",
"strength": "required",
"description": "Codes for questionnaires and groupings of questionnaire questions"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Questionnaire.group.required",
"short": "Must group be included in data results?",
"definition": "If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.repeats",
"short": "Whether the group may repeat",
"definition": "Whether the group may occur multiple times in the instance, containing multiple sets of answers.",
"requirements": "Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.group",
"short": "Nested questionnaire group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
},
{
"path": "Questionnaire.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"min": 0,
"max": "*",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
}
]
},
{
"path": "Questionnaire.group.question.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.question.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Questionnaire.group.question.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Questionnaire.group.question.linkId",
"short": "To link questionnaire with questionnaire answers",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireAnswers]]] resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements": "[[[QuestionnaireAnswers]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.question.concept",
"short": "Concept that represents this question on a questionnaire",
"definition": "Identifies a how this question is known in a particular terminology such as LOINC.",
"requirements": "Allows linking of questions (and their answers) to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"alias": [
"Question"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
}
]
},
{
"path": "Questionnaire.group.question.type",
"short": "boolean | decimal | integer | date | dateTime +",
"definition": "The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.",
"comments": "Additional constraints on the type of answer can be conveyed by extensions.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AnswerFormat",
"strength": "required",
"description": "The expected format of an answer",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/answer-format"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.required",
"short": "Must question be answered in data results?",
"definition": "If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.question.repeats",
"short": "Can question have multiple answers?",
"definition": "If true, the question may have more than one answer.",
"comments": "Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.",
"requirements": "Used for \"check all that apply\" types of questions or \"list your top 3\", etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.question.options",
"short": "Valueset containing the possible options",
"definition": "Reference to a valueset containing the possible options.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
}
]
},
{
"path": "Questionnaire.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min": 0,
"max": "*",
"nameReference": "group",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Questionnaire",
"short": "A structured set of questions",
"definition": "A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.",
"alias": [
"Form",
"CRF",
"Survey"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "que-2",
"name": "UniqueLinkIds",
"severity": "error",
"human": "The link ids for groups and questions must be unique within the questionnaire",
"xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=DEF]"
}
]
},
{
"path": "Questionnaire.identifier",
"short": "External Ids for this questionnaire",
"definition": "This records identifiers associated with this question set that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=BUS]"
}
]
},
{
"path": "Questionnaire.version",
"short": "Logical id for this version of Questionnaire",
"definition": "The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.",
"requirements": "In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).",
"alias": [
"N/A - MIF rather than RIM level"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id[use=VER]"
}
]
},
{
"path": "Questionnaire.status",
"short": "draft | published | retired",
"definition": "The lifecycle status of the questionnaire as a whole.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "QuestionnaireStatus",
"strength": "required",
"description": "Lifecycle status of the questionnaire",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/questionnaire-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}
]
},
{
"path": "Questionnaire.date",
"short": "Date this version was authored",
"definition": "The date that this questionnaire was last changed.",
"alias": [
"Date Created",
"Date published",
"Date Issued",
"Date updated"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "Questionnaire.publisher",
"short": "Organization/individual who designed the questionnaire",
"definition": "Organization or person responsible for developing and maintaining the questionnaire.",
"requirements": "Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's \"authority\".",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "Questionnaire.telecom",
"short": "Contact information of the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role.telecom"
}
]
},
{
"path": "Questionnaire.group",
"name": "group",
"short": "Grouped questions",
"definition": "A collection of related questions (or further groupings of questions).",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"alias": [
"Section"
],
"min": 1,
"max": "1",
"constraint": [
{
"key": "que-1",
"name": "GroupHaveSubOrQuestions",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
},
{
"path": "Questionnaire.group.linkId",
"short": "To link questionnaire with questionnaire answers",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireAnswers resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements": "[[[QuestionnaireAnswers]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.title",
"short": "Name to be displayed for group",
"definition": "The human-readable name for this section of the questionnaire.",
"comments": "The title of the \"root\" group is the title for the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "Questionnaire.group.concept",
"short": "Concept that represents this section on a questionnaire",
"definition": "Identifies a how this group of questions is known in a particular terminology such as LOINC.",
"comments": "The code(s) for the \"root\" group apply to the questionnaire as a whole.",
"requirements": "Allows linking of groups of questions (and complete questionnaires) to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "QuestionnaireGroupConcept",
"strength": "required",
"description": "Codes for questionnaires and groupings of questionnaire questions"
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Questionnaire.group.required",
"short": "Must group be included in data results?",
"definition": "If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.repeats",
"short": "Whether the group may repeat",
"definition": "Whether the group may occur multiple times in the instance, containing multiple sets of answers.",
"requirements": "Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.group",
"short": "Nested questionnaire group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
},
{
"path": "Questionnaire.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"min": 0,
"max": "*",
"condition": [
"que-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
}
]
},
{
"path": "Questionnaire.group.question.linkId",
"short": "To link questionnaire with questionnaire answers",
"definition": "An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireAnswers]]] resource.",
"comments": "May be omitted if there is no expectation to link answers back to a questionnaire. This *can* be a meaningful id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.",
"requirements": "[[[QuestionnaireAnswers]]] does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Questionnaire.group.question.concept",
"short": "Concept that represents this question on a questionnaire",
"definition": "Identifies a how this question is known in a particular terminology such as LOINC.",
"requirements": "Allows linking of questions (and their answers) to formal terminologies.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Questionnaire.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"comments": "Common extensions are defined for more specialized types of display text.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"alias": [
"Question"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
}
]
},
{
"path": "Questionnaire.group.question.type",
"short": "boolean | decimal | integer | date | dateTime +",
"definition": "The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.",
"comments": "Additional constraints on the type of answer can be conveyed by extensions.",
"requirements": "Defines the format in which the user is to be prompted for the answer.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AnswerFormat",
"strength": "required",
"description": "The expected format of an answer",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/answer-format"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A - MIF rather than RIM level"
}
]
},
{
"path": "Questionnaire.group.question.required",
"short": "Must question be answered in data results?",
"definition": "If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.question.repeats",
"short": "Can question have multiple answers?",
"definition": "If true, the question may have more than one answer.",
"comments": "Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.",
"requirements": "Used for \"check all that apply\" types of questions or \"list your top 3\", etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer"
}
]
},
{
"path": "Questionnaire.group.question.options",
"short": "Valueset containing the possible options",
"definition": "Reference to a valueset containing the possible options.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"mapping": [
{
"identity": "rim",
"map": "Not supported - MIF/templating layer to capture value set"
}
]
},
{
"path": "Questionnaire.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min": 0,
"max": "*",
"nameReference": "group",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "QuestionnaireAnswers",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/QuestionnaireAnswers",
"name": "QuestionnaireAnswers",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for QuestionnaireAnswers Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "QuestionnaireAnswers",
"short": "A structured set of questions and their answers",
"definition": "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.",
"alias": [
"Form"
],
"min": 1,
"max": "1",
"type": [
{
"code": "QuestionnaireAnswers"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "QuestionnaireAnswers.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "QuestionnaireAnswers.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "QuestionnaireAnswers.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "QuestionnaireAnswers.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "QuestionnaireAnswers.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.identifier",
"short": "Unique id for this set of answers",
"definition": "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements": "Used for tracking, registration and other business purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "QuestionnaireAnswers.questionnaire",
"short": "Form being answered",
"definition": "Indicates the Questionnaire resource that defines the form for which answers are being provided.",
"requirements": "Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form.",
"alias": [
"Form"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.status",
"short": "in-progress | completed | amended",
"definition": "The lifecycle status of the questionnaire answers as a whole.",
"requirements": "The information on questionnaires may possibly be gathered during multiple sessions and altered after considered being finished. Questionnaires with just questions may serve as template forms, with the applicable publication statuses.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "QuestionnaireAnswersStatus",
"strength": "required",
"description": "Lifecycle status of the questionnaire answers",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/questionnaire-answers-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}
]
},
{
"path": "QuestionnaireAnswers.subject",
"short": "The subject of the questions",
"definition": "The subject of the questionnaire answers. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.",
"requirements": "Must know the subject context.",
"alias": [
"Patient",
"Focus"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "QuestionnaireAnswers.author",
"short": "Person who received and recorded the answers",
"definition": "Person who received the answers to the questions in the QuestionnaireAnswers and recorded them in the system.",
"comments": "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.",
"requirements": "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias": [
"Laboratory",
"Service",
"Practitioner",
"Department",
"Company"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "QuestionnaireAnswers.authored",
"short": "Date this version was authored",
"definition": "The date and/or time that this version of the questionnaire answers was authored.",
"comments": "May be different from the update time of the resource itself, because that is the status of the collection and authoring. This element is optional to allow for systems that may not know the value, however it SHOULD be populated if possible.",
"requirements": "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias": [
"Date Created",
"Date published",
"Date Issued",
"Date updated"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "QuestionnaireAnswers.source",
"short": "The person who answered the questions",
"definition": "The person who answered the questions about the subject.",
"comments": "If not specified, no inference can be made about who provided the data.",
"requirements": "When answering questions about a subject that is minor, incapable of answering or an animal, another human source is used to answer the questions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
}
]
},
{
"path": "QuestionnaireAnswers.encounter",
"short": "Primary encounter during which the answers were collected",
"definition": "Encounter during which this set of questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.",
"requirements": "Some institutions track questionnaires under a specific encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group",
"name": "group",
"short": "Grouped questions",
"definition": "A group of questions to a possibly similarly grouped set of questions in the questionnaire answers.",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "qan-1",
"name": "GroupHaveSubOrQuestions",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.group.linkId",
"short": "Corresponding group within Questionnaire",
"definition": "Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireAnswers resource.",
"requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.title",
"short": "Name for this group",
"definition": "Text that is displayed above the contents of the group.",
"comments": "On the root group, this is the title of the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "QuestionnaireAnswers.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "QuestionnaireAnswers.group.subject",
"short": "The subject this group's answers are about",
"definition": "More specific subject this section's answers are about, details the subject given in QuestionnaireAnswers.",
"requirements": "Sometimes a group of answers is about a specific participant, artifact or piece of information in the patient's care or record, e.g. a specific Problem, RelatedPerson, Allergy etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role\nor\n.outboundRelationship[typeCode=SUBJ].target"
}
]
},
{
"path": "QuestionnaireAnswers.group.group",
"short": "Nested questionnaire answers group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"condition": [
"qan-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"min": 0,
"max": "*",
"condition": [
"qan-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.linkId",
"short": "Corresponding question within Questionnaire",
"definition": "Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireAnswers resource.",
"requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer",
"short": "The response(s) to the question",
"definition": "The respondent's answer(s) to the question.",
"comments": "We nest the value because we can't have a repeating structure that has variable type.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".value[type=LIST_ANY]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer.value[x]",
"short": "Single-valued answer to the question",
"definition": "The answer (or one of the answers) provided by the respondant to the question.",
"comments": "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions.",
"requirements": "Need to be able to retain a single-valued answer to a question.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "decimal"
},
{
"code": "integer"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "instant"
},
{
"code": "time"
},
{
"code": "string"
},
{
"code": "uri"
},
{
"code": "Attachment"
},
{
"code": "Coding"
},
{
"code": "Quantity"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".item"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min": 0,
"max": "*",
"nameReference": "group",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"path": "QuestionnaireAnswers",
"short": "A structured set of questions and their answers",
"definition": "A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.",
"requirements": "To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.",
"alias": [
"Form"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Observation[moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.identifier",
"short": "Unique id for this set of answers",
"definition": "A business identifier assigned to a particular completed (or partially completed) questionnaire.",
"requirements": "Used for tracking, registration and other business purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "QuestionnaireAnswers.questionnaire",
"short": "Form being answered",
"definition": "Indicates the Questionnaire resource that defines the form for which answers are being provided.",
"requirements": "Needed to allow editing of the questionnaire in a manner that enforces the constraints of the original form.",
"alias": [
"Form"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./outboundRelationship[typeCode=INST]/target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.status",
"short": "in-progress | completed | amended",
"definition": "The lifecycle status of the questionnaire answers as a whole.",
"requirements": "The information on questionnaires may possibly be gathered during multiple sessions and altered after considered being finished. Questionnaires with just questions may serve as template forms, with the applicable publication statuses.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "QuestionnaireAnswersStatus",
"strength": "required",
"description": "Lifecycle status of the questionnaire answers",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/questionnaire-answers-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)"
}
]
},
{
"path": "QuestionnaireAnswers.subject",
"short": "The subject of the questions",
"definition": "The subject of the questionnaire answers. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.",
"requirements": "Must know the subject context.",
"alias": [
"Patient",
"Focus"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "QuestionnaireAnswers.author",
"short": "Person who received and recorded the answers",
"definition": "Person who received the answers to the questions in the QuestionnaireAnswers and recorded them in the system.",
"comments": "Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation.",
"requirements": "Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers.",
"alias": [
"Laboratory",
"Service",
"Practitioner",
"Department",
"Company"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].role"
}
]
},
{
"path": "QuestionnaireAnswers.authored",
"short": "Date this version was authored",
"definition": "The date and/or time that this version of the questionnaire answers was authored.",
"comments": "May be different from the update time of the resource itself, because that is the status of the collection and authoring. This element is optional to allow for systems that may not know the value, however it SHOULD be populated if possible.",
"requirements": "Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers.",
"alias": [
"Date Created",
"Date published",
"Date Issued",
"Date updated"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"path": "QuestionnaireAnswers.source",
"short": "The person who answered the questions",
"definition": "The person who answered the questions about the subject.",
"comments": "If not specified, no inference can be made about who provided the data.",
"requirements": "When answering questions about a subject that is minor, incapable of answering or an animal, another human source is used to answer the questions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role"
}
]
},
{
"path": "QuestionnaireAnswers.encounter",
"short": "Primary encounter during which the answers were collected",
"definition": "Encounter during which this set of questionnaire answers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.",
"requirements": "Some institutions track questionnaires under a specific encounter.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group",
"name": "group",
"short": "Grouped questions",
"definition": "A group of questions to a possibly similarly grouped set of questions in the questionnaire answers.",
"comments": "The Questionnaire itself has one \"root\" group with the actual contents of the Questionnaire.",
"requirements": "Need to be able to logically group answers to grouped questions.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "qan-1",
"name": "GroupHaveSubOrQuestions",
"severity": "error",
"human": "Groups may either contain questions or groups but not both",
"xpath": "not(exists(f:group) and exists(f:question))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.linkId",
"short": "Corresponding group within Questionnaire",
"definition": "Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireAnswers resource.",
"requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.title",
"short": "Name for this group",
"definition": "Text that is displayed above the contents of the group.",
"comments": "On the root group, this is the title of the questionnaire.",
"requirements": "When including text for the questionnaire with the answers, sections may have a section header.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".title"
}
]
},
{
"path": "QuestionnaireAnswers.group.text",
"short": "Additional text for the group",
"definition": "Additional text for the group, used for display purposes.",
"requirements": "When including text for the questionnaire, each section may contain additional explanations are background text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "QuestionnaireAnswers.group.subject",
"short": "The subject this group's answers are about",
"definition": "More specific subject this section's answers are about, details the subject given in QuestionnaireAnswers.",
"requirements": "Sometimes a group of answers is about a specific participant, artifact or piece of information in the patient's care or record, e.g. a specific Problem, RelatedPerson, Allergy etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role\nor\n.outboundRelationship[typeCode=SUBJ].target"
}
]
},
{
"path": "QuestionnaireAnswers.group.group",
"short": "Nested questionnaire answers group",
"definition": "A sub-group within a group. The ordering of groups within this group is relevant.",
"requirements": "Reports can consist of complex nested groups.",
"min": 0,
"max": "*",
"nameReference": "group",
"condition": [
"qan-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question",
"short": "Questions in this group",
"definition": "Set of questions within this group. The order of questions within the group is relevant.",
"requirements": "Must register answers to questions.",
"alias": [
"Responses",
"Contents"
],
"min": 0,
"max": "*",
"condition": [
"qan-1"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=EVN or DEF]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.linkId",
"short": "Corresponding question within Questionnaire",
"definition": "Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireAnswers resource.",
"requirements": "Groups can repeat in the answers, so a direct 1..1 correspondence may not exist - requiring correspondence by id.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=OBS, moodCode=DEFN]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.text",
"short": "Text of the question as it is shown to the user",
"definition": "The actual question as shown to the user to prompt them for an answer.",
"requirements": "When including text for the questionnaire, each question may contain its actual question display text.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code.display"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer",
"short": "The response(s) to the question",
"definition": "The respondent's answer(s) to the question.",
"comments": "We nest the value because we can't have a repeating structure that has variable type.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".value[type=LIST_ANY]"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.answer.value[x]",
"short": "Single-valued answer to the question",
"definition": "The answer (or one of the answers) provided by the respondant to the question.",
"comments": "More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions.",
"requirements": "Need to be able to retain a single-valued answer to a question.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "decimal"
},
{
"code": "integer"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "instant"
},
{
"code": "time"
},
{
"code": "string"
},
{
"code": "uri"
},
{
"code": "Attachment"
},
{
"code": "Coding"
},
{
"code": "Quantity"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".item"
}
]
},
{
"path": "QuestionnaireAnswers.group.question.group",
"short": "Nested questionnaire group",
"definition": "Nested group, containing nested question for this question. The order of groups within the question is relevant.",
"requirements": "It is useful to have \"sub-questions\", questions which normally appear when certain answers are given and which collect additional details.",
"min": 0,
"max": "*",
"nameReference": "group",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=DOCSECT, moodCode=EVN]"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "ReferralRequest",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ReferralRequest",
"name": "ReferralRequest",
"publisher": "HL7 FHIR Project (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ReferralRequest Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ReferralRequest",
"short": "A request for referral or transfer of care",
"definition": "Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organisation.",
"alias": [
"ReferralRequest\rTransferOfCare Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "ReferralRequest"
}
]
},
{
"path": "ReferralRequest.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "ReferralRequest.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "ReferralRequest.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "ReferralRequest.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "ReferralRequest.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "ReferralRequest.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ReferralRequest.status",
"short": "draft | sent | active | cancelled | rejected | completed",
"definition": "The workflow status of the referral or transfer of care request.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ReferralStatus",
"strength": "required",
"description": "The status of the referral",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referralstatus"
}
}
},
{
"path": "ReferralRequest.identifier",
"short": "Identifier of request",
"definition": "Business Id that uniquely identifies the referral/care transfer request instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.type",
"short": "Referral/Transition of care request type",
"definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.",
"comments": "Examples of referral type:\r- consultation; \r second opinion; \r third opinion\r- Assume management\r- Request for procedure(s)\r\rHL7 v2.8 Example - Table 0336:\rS = second opinion\rp = patient preference\ro = provider ordered\rw = work load.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.specialty",
"short": "The clinical specialty (discipline) that the referral is requested for",
"definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent.",
"comments": "Examples:\rCardiology\rGastroenterology\rDiabetology.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.priority",
"short": "Urgency of referral / transfer of care request",
"definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.patient",
"short": "Patient referred to care or transfer",
"definition": "The patient who is the subject of a referral or transfer of care request.",
"comments": "Referral of family, group or community is to be catered for by profiles.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.requester",
"short": "Requester of referral / transfer of care",
"definition": "The healthcare provider or provider organization who/which initaited the referral/transfer of care request. Can also be Patient (a self referral).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.recipient",
"short": "Receiver of referral / transfer of care request",
"definition": "The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.",
"comments": "There will be a primary receiver.\rBut the request can be received by any number of \"copied to\" providers or organisations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.encounter",
"short": "Encounter",
"definition": "The encounter at which the request for referral or transfer of care is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.dateSent",
"short": "Date referral/transfer of care request is sent",
"definition": "Date/DateTime the request for referral or transfer of care is sent by the author.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.reason",
"short": "Reason for referral / Transfer of care request",
"definition": "Description of clinical condition indicating why referral/transfer of care is requested.",
"comments": "Examples:\r\"2nd degree AV block\"\r\rOral Health example ReferralReasonCode:\r01 = Pathological Anomalies\r02 = Disabled (physical or mental)\r03 = Complexity of Treatment\r04 = Seizure Disorders\r05 = Extensive Surgery\r06 = Surgical Complexity\r07 = Rampant decay\r08 = Medical History (to provide details upon request)\r09 = Temporal Mandibular Joint Anomalies\r10 = Accidental Injury\r11 = Anaesthesia complications (local or general)\r12 = Developmental Anomalies\r13 = Behavioral Management.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.description",
"short": "A textual description of the referral",
"definition": "The reason gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.",
"comments": "This would be a good candidate for a 'markdown' data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.serviceRequested",
"short": "Service(s) requested",
"definition": "The service(s) that is/are requested to be provided to the patient.",
"comments": "Examples:\r\"cardiac pacemaker insertion\"\r\rHL7 v3 Concept domain - ReferralReasonCode examples:\r- Specialized medical assistance\r- Other care requirement.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.supportingInformation",
"short": "Additonal information to support referral or transfer of care request",
"definition": "Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care.",
"comments": "Examples include:\rPresenting problems/chief complaints\rMedical History\rFamily History\rAlerts\rAllergy/Intolerance and Adverse Reactions\rMedications\rObservations/Assessments (may include cognitive and fundtional assessments)\rDiagnostic Reports\rCare Plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.fulfillmentTime",
"short": "Requested service(s) fulfillment time",
"definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.",
"requirements": "Use cases:\r(1) to indicate that the requested service is not to happen before a specified date\r(2) to indicate that the requested service must happen before a specified date\r(3) to indicate that the requested service must happen during the specified dates (\"low\" and \"high\" values).",
"alias": [
"EffectiveTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"isSummary": true
}
]
},
"differential": {
"element": [
{
"path": "ReferralRequest",
"short": "A request for referral or transfer of care",
"definition": "Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organisation.",
"alias": [
"ReferralRequest\rTransferOfCare Request"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "ReferralRequest.status",
"short": "draft | sent | active | cancelled | rejected | completed",
"definition": "The workflow status of the referral or transfer of care request.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ReferralStatus",
"strength": "required",
"description": "The status of the referral",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/referralstatus"
}
}
},
{
"path": "ReferralRequest.identifier",
"short": "Identifier of request",
"definition": "Business Id that uniquely identifies the referral/care transfer request instance.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.type",
"short": "Referral/Transition of care request type",
"definition": "An indication of the type of referral (or where applicable the type of transfer of care) request.",
"comments": "Examples of referral type:\r- consultation; \r second opinion; \r third opinion\r- Assume management\r- Request for procedure(s)\r\rHL7 v2.8 Example - Table 0336:\rS = second opinion\rp = patient preference\ro = provider ordered\rw = work load.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.specialty",
"short": "The clinical specialty (discipline) that the referral is requested for",
"definition": "Indication of the clinical domain or discipline to which the referral or transfer of care request is sent.",
"comments": "Examples:\rCardiology\rGastroenterology\rDiabetology.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.priority",
"short": "Urgency of referral / transfer of care request",
"definition": "An indication of the urgency of referral (or where applicable the type of transfer of care) request.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.patient",
"short": "Patient referred to care or transfer",
"definition": "The patient who is the subject of a referral or transfer of care request.",
"comments": "Referral of family, group or community is to be catered for by profiles.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.requester",
"short": "Requester of referral / transfer of care",
"definition": "The healthcare provider or provider organization who/which initaited the referral/transfer of care request. Can also be Patient (a self referral).",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.recipient",
"short": "Receiver of referral / transfer of care request",
"definition": "The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.",
"comments": "There will be a primary receiver.\rBut the request can be received by any number of \"copied to\" providers or organisations.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.encounter",
"short": "Encounter",
"definition": "The encounter at which the request for referral or transfer of care is initiated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.dateSent",
"short": "Date referral/transfer of care request is sent",
"definition": "Date/DateTime the request for referral or transfer of care is sent by the author.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.reason",
"short": "Reason for referral / Transfer of care request",
"definition": "Description of clinical condition indicating why referral/transfer of care is requested.",
"comments": "Examples:\r\"2nd degree AV block\"\r\rOral Health example ReferralReasonCode:\r01 = Pathological Anomalies\r02 = Disabled (physical or mental)\r03 = Complexity of Treatment\r04 = Seizure Disorders\r05 = Extensive Surgery\r06 = Surgical Complexity\r07 = Rampant decay\r08 = Medical History (to provide details upon request)\r09 = Temporal Mandibular Joint Anomalies\r10 = Accidental Injury\r11 = Anaesthesia complications (local or general)\r12 = Developmental Anomalies\r13 = Behavioral Management.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.description",
"short": "A textual description of the referral",
"definition": "The reason gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.",
"comments": "This would be a good candidate for a 'markdown' data type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "ReferralRequest.serviceRequested",
"short": "Service(s) requested",
"definition": "The service(s) that is/are requested to be provided to the patient.",
"comments": "Examples:\r\"cardiac pacemaker insertion\"\r\rHL7 v3 Concept domain - ReferralReasonCode examples:\r- Specialized medical assistance\r- Other care requirement.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.supportingInformation",
"short": "Additonal information to support referral or transfer of care request",
"definition": "Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care.",
"comments": "Examples include:\rPresenting problems/chief complaints\rMedical History\rFamily History\rAlerts\rAllergy/Intolerance and Adverse Reactions\rMedications\rObservations/Assessments (may include cognitive and fundtional assessments)\rDiagnostic Reports\rCare Plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isModifier": false,
"isSummary": true
},
{
"path": "ReferralRequest.fulfillmentTime",
"short": "Requested service(s) fulfillment time",
"definition": "The period of time within which the services identified in the referral/transfer of care is specified or required to occur.",
"requirements": "Use cases:\r(1) to indicate that the requested service is not to happen before a specified date\r(2) to indicate that the requested service must happen before a specified date\r(3) to indicate that the requested service must happen during the specified dates (\"low\" and \"high\" values).",
"alias": [
"EffectiveTime"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"isSummary": true
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "RelatedPerson",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
"name": "RelatedPerson",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for RelatedPerson Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "RelatedPerson",
"short": "An person that is related to a patient, but who is not a direct target of care",
"definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"requirements": "Need to track persons related to the patient or the healthcare process.",
"min": 1,
"max": "1",
"type": [
{
"code": "RelatedPerson"
}
],
"mapping": [
{
"identity": "rim",
"map": "role"
}
]
},
{
"path": "RelatedPerson.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "RelatedPerson.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "RelatedPerson.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "RelatedPerson.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "RelatedPerson.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "RelatedPerson.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RelatedPerson.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RelatedPerson.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RelatedPerson.identifier",
"short": "A Human identifier for this person",
"definition": "Identifier for a person within a particular scope.",
"requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-33"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "RelatedPerson.patient",
"short": "The patient this person is related to",
"definition": "The patient this person is related to.",
"requirements": "We need to know which Patient this RelatedPerson is related to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
}
]
},
{
"path": "RelatedPerson.relationship",
"short": "The nature of the relationship",
"definition": "The nature of the relationship between a patient and the related person.",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PatientRelationshipType",
"strength": "required",
"description": "The nature of the relationship between a patient and the related person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "RelatedPerson.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "RelatedPerson.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-5 / NK1-6 / NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "RelatedPerson.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "administrativeGender"
}
]
},
{
"path": "RelatedPerson.address",
"short": "Address where the related person can be contacted or visited",
"definition": "Address where the related person can be contacted or visited.",
"requirements": "Need to keep track where the related person can be contacted per postal mail or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-4"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "RelatedPerson.photo",
"short": "Image of the person",
"definition": "Image of the person.",
"requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
}
]
},
{
"path": "RelatedPerson.period",
"short": "Period of time that this relationship is considered valid",
"definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
},
"differential": {
"element": [
{
"path": "RelatedPerson",
"short": "An person that is related to a patient, but who is not a direct target of care",
"definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.",
"requirements": "Need to track persons related to the patient or the healthcare process.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "role"
}
]
},
{
"path": "RelatedPerson.identifier",
"short": "A Human identifier for this person",
"definition": "Identifier for a person within a particular scope.",
"requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-33"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "RelatedPerson.patient",
"short": "The patient this person is related to",
"definition": "The patient this person is related to.",
"requirements": "We need to know which Patient this RelatedPerson is related to.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"
}
]
},
{
"path": "RelatedPerson.relationship",
"short": "The nature of the relationship",
"definition": "The nature of the relationship between a patient and the related person.",
"requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "PatientRelationshipType",
"strength": "required",
"description": "The nature of the relationship between a patient and the related person",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/relatedperson-relationshiptype"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "RelatedPerson.name",
"short": "A name associated with the person",
"definition": "A name associated with the person.",
"requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "RelatedPerson.telecom",
"short": "A contact detail for the person",
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"comments": "Person may have multiple ways to be contacted with different uses or applicable periods. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-5 / NK1-6 / NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "RelatedPerson.gender",
"short": "male | female | other | unknown",
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements": "Needed for identification of the person, in combination with (at least) name and birth date.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "administrativeGender"
}
]
},
{
"path": "RelatedPerson.address",
"short": "Address where the related person can be contacted or visited",
"definition": "Address where the related person can be contacted or visited.",
"requirements": "Need to keep track where the related person can be contacted per postal mail or visited.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-4"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"path": "RelatedPerson.photo",
"short": "Image of the person",
"definition": "Image of the person.",
"requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"
}
]
},
{
"path": "RelatedPerson.period",
"short": "Period of time that this relationship is considered valid",
"definition": "The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "RiskAssessment",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/RiskAssessment",
"name": "RiskAssessment",
"publisher": "HL7 FHIR Project (Clinical Decision Support)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/dss/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for RiskAssessment Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "openehr",
"uri": "http://openehr.org",
"name": "Open EHR"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "RiskAssessment",
"short": "Potential outcomes for a subject with likelihood",
"definition": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
"alias": [
"Prognosis"
],
"min": 1,
"max": "1",
"type": [
{
"code": "RiskAssessment"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code=\"Risk Assessment\"]"
},
{
"identity": "openehr",
"map": "OpenEHR-EHR-EVALUATION.risk.v1"
}
]
},
{
"path": "RiskAssessment.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "RiskAssessment.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "RiskAssessment.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "RiskAssessment.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "RiskAssessment.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "RiskAssessment.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RiskAssessment.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RiskAssessment.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RiskAssessment.subject",
"short": "Who/what does assessment apply to?",
"definition": "The patient or group the risk assessment applies to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "openehr",
"map": "Subject of Care"
}
]
},
{
"path": "RiskAssessment.date",
"short": "When was assessment made?",
"definition": "The date (and possibly time) the risk assessment was performed.",
"requirements": "The assessment results lose validity the more time elapses from when they are first made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "RiskAssessment.condition",
"short": "Condition assessed",
"definition": "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "RiskAssessment.performer",
"short": "Who did assessment?",
"definition": "The provider or software application that performed the assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGNED]"
},
{
"identity": "openehr",
"map": "Information Provider"
}
]
},
{
"path": "RiskAssessment.identifier",
"short": "Unique identifier for the assessment",
"definition": "Business identifier assigned to the risk assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "openehr",
"map": "Workflow Identifier"
}
]
},
{
"path": "RiskAssessment.method",
"short": "Evaluation mechanism",
"definition": "The algorithm, processs or mechanism used to evaluate the risk.",
"requirements": "The method can influence the results of the assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "RiskAssessmentMethod",
"strength": "example",
"description": "The mechanism or algorithm used to make the assessment. E.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc."
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "RiskAssessment.basis",
"short": "Information used in assessment",
"definition": "Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DRIV].target"
},
{
"identity": "openehr",
"map": "Risk Factor; Link to Evidence"
}
]
},
{
"path": "RiskAssessment.prediction",
"short": "Outcome predicted",
"definition": "Describes the expected outcome for the subject.",
"comments": "Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=VALUE].target[classCod=OBS, moodCode=RISK]"
}
]
},
{
"path": "RiskAssessment.prediction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "RiskAssessment.prediction.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "RiskAssessment.prediction.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "RiskAssessment.prediction.outcome",
"short": "Possible outcome for the subject",
"definition": "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RiskAssessmentOutcome",
"strength": "example",
"description": "The condition or other outcome. E.g. death, remission, amputation, infection, etc."
},
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "openehr",
"map": "Risk"
}
]
},
{
"path": "RiskAssessment.prediction.probability[x]",
"short": "Likelihood of specified outcome",
"definition": "How likely is the outcome (in the specified timeframe).",
"comments": "If range is used, it represents the lower and upper bounds of certainty. E.g. 40-60%\n\nDecimal values are expressed as percentages as well (max = 100).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
},
{
"code": "Range"
},
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ras-1",
"name": "Probability Range Percentage",
"severity": "error",
"human": "low and high must be percentages, if present",
"xpath": "(not(f:low) or f:low[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org']) and (not(f:high) or f:high[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org'])"
},
{
"key": "ras-2",
"name": "Probability percentage",
"severity": "error",
"human": "Must be <= 100",
"xpath": "@value <= 100"
}
],
"binding": {
"name": "RiskAssessmentProbability",
"strength": "example",
"description": "The likelihood of the occurrence of a specified outcome",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/risk-probability"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"probability\"].value"
},
{
"identity": "openehr",
"map": "Category"
}
]
},
{
"path": "RiskAssessment.prediction.relativeRisk",
"short": "Relative likelihood",
"definition": "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).",
"requirements": "Absolute risk is less meaningful than relative risk.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"relative risk\"].value"
}
]
},
{
"path": "RiskAssessment.prediction.when[x]",
"short": "Timeframe or age range",
"definition": "Indicates the period of time or age range of the subject to which the specified probability applies.",
"comments": "If not specified, the risk applies \"over the subject's lifespan\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "Range"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age\"].value"
}
]
},
{
"path": "RiskAssessment.prediction.rationale",
"short": "Explanation of prediction",
"definition": "Additional information explaining the basis for the prediction.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.text"
},
{
"identity": "openehr",
"map": "Rationale"
}
]
},
{
"path": "RiskAssessment.mitigation",
"short": "How to reduce risk",
"definition": "A description of the steps that might be taken to reduce the identified risk(s).",
"requirements": "One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MTGT].target[classCode=ACT, moodCode=EVN].text"
}
]
}
]
},
"differential": {
"element": [
{
"path": "RiskAssessment",
"short": "Potential outcomes for a subject with likelihood",
"definition": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.",
"alias": [
"Prognosis"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=EVN, code=\"Risk Assessment\"]"
},
{
"identity": "openehr",
"map": "OpenEHR-EHR-EVALUATION.risk.v1"
}
]
},
{
"path": "RiskAssessment.subject",
"short": "Who/what does assessment apply to?",
"definition": "The patient or group the risk assessment applies to.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
},
{
"identity": "openehr",
"map": "Subject of Care"
}
]
},
{
"path": "RiskAssessment.date",
"short": "When was assessment made?",
"definition": "The date (and possibly time) the risk assessment was performed.",
"requirements": "The assessment results lose validity the more time elapses from when they are first made.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "RiskAssessment.condition",
"short": "Condition assessed",
"definition": "For assessments or prognosis specific to a particular condition, indicates the condition being assessed.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
}
]
},
{
"path": "RiskAssessment.performer",
"short": "Who did assessment?",
"definition": "The provider or software application that performed the assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGNED]"
},
{
"identity": "openehr",
"map": "Information Provider"
}
]
},
{
"path": "RiskAssessment.identifier",
"short": "Unique identifier for the assessment",
"definition": "Business identifier assigned to the risk assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "openehr",
"map": "Workflow Identifier"
}
]
},
{
"path": "RiskAssessment.method",
"short": "Evaluation mechanism",
"definition": "The algorithm, processs or mechanism used to evaluate the risk.",
"requirements": "The method can influence the results of the assessment.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "RiskAssessmentMethod",
"strength": "example",
"description": "The mechanism or algorithm used to make the assessment. E.g. TIMI, PRISM, Cardiff Type 2 diabetes, etc."
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "RiskAssessment.basis",
"short": "Information used in assessment",
"definition": "Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DRIV].target"
},
{
"identity": "openehr",
"map": "Risk Factor; Link to Evidence"
}
]
},
{
"path": "RiskAssessment.prediction",
"short": "Outcome predicted",
"definition": "Describes the expected outcome for the subject.",
"comments": "Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=VALUE].target[classCod=OBS, moodCode=RISK]"
}
]
},
{
"path": "RiskAssessment.prediction.outcome",
"short": "Possible outcome for the subject",
"definition": "One of the potential outcomes for the patient (e.g. remission, death, a particular condition).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "RiskAssessmentOutcome",
"strength": "example",
"description": "The condition or other outcome. E.g. death, remission, amputation, infection, etc."
},
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "openehr",
"map": "Risk"
}
]
},
{
"path": "RiskAssessment.prediction.probability[x]",
"short": "Likelihood of specified outcome",
"definition": "How likely is the outcome (in the specified timeframe).",
"comments": "If range is used, it represents the lower and upper bounds of certainty. E.g. 40-60%\n\nDecimal values are expressed as percentages as well (max = 100).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
},
{
"code": "Range"
},
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ras-1",
"name": "Probability Range Percentage",
"severity": "error",
"human": "low and high must be percentages, if present",
"xpath": "(not(f:low) or f:low[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org']) and (not(f:high) or f:high[f:code/@value='%' and f:system/@value='http://unitsofmeasure.org'])"
},
{
"key": "ras-2",
"name": "Probability percentage",
"severity": "error",
"human": "Must be <= 100",
"xpath": "@value <= 100"
}
],
"binding": {
"name": "RiskAssessmentProbability",
"strength": "example",
"description": "The likelihood of the occurrence of a specified outcome",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/risk-probability"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"probability\"].value"
},
{
"identity": "openehr",
"map": "Category"
}
]
},
{
"path": "RiskAssessment.prediction.relativeRisk",
"short": "Relative likelihood",
"definition": "Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).",
"requirements": "Absolute risk is less meaningful than relative risk.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"relative risk\"].value"
}
]
},
{
"path": "RiskAssessment.prediction.when[x]",
"short": "Timeframe or age range",
"definition": "Indicates the period of time or age range of the subject to which the specified probability applies.",
"comments": "If not specified, the risk applies \"over the subject's lifespan\".",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
},
{
"code": "Range"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime or .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"age\"].value"
}
]
},
{
"path": "RiskAssessment.prediction.rationale",
"short": "Explanation of prediction",
"definition": "Additional information explaining the basis for the prediction.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".reasonCode.text"
},
{
"identity": "openehr",
"map": "Rationale"
}
]
},
{
"path": "RiskAssessment.mitigation",
"short": "How to reduce risk",
"definition": "A description of the steps that might be taken to reduce the identified risk(s).",
"requirements": "One of the main reasons for assessing risks is to identify whether interventional steps are needed to reduce risk.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=MTGT].target[classCode=ACT, moodCode=EVN].text"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Schedule",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Schedule",
"name": "Schedule",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Schedule Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Schedule",
"short": "A container for slot(s) of time that may be available for booking appointments",
"definition": "A container for slot(s) of time that may be available for booking appointments.",
"alias": [
"Availability"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Schedule"
}
],
"mapping": [
{
"identity": "ical",
"map": "BEGIN:VFREEBUSY ??? END:VFREEBUSY\n(If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)"
}
]
},
{
"path": "Schedule.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Schedule.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Schedule.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Schedule.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Schedule.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Schedule.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Schedule.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Schedule.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Schedule.identifier",
"short": "External Ids for this item",
"definition": "External Ids for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Schedule.type",
"short": "The schedule type can be used for the categorization of healthcare services or other appointment types",
"definition": "The schedule type can be used for the categorization of healthcare services or other appointment types.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "Schedule.actor",
"short": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson",
"definition": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE:MAILTO:john_public@host2.com\nThis can be populated with a value from the referenced resource"
}
]
},
{
"path": "Schedule.planningHorizon",
"short": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates",
"definition": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "DTSTART:20131201T003000Z\nDTEND:2014030101T003000Z"
}
]
},
{
"path": "Schedule.comment",
"short": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated",
"definition": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT:(comment)\nIf there is no comment, then the line can be excluded from the iCalendar entry"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Schedule",
"short": "A container for slot(s) of time that may be available for booking appointments",
"definition": "A container for slot(s) of time that may be available for booking appointments.",
"alias": [
"Availability"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "ical",
"map": "BEGIN:VFREEBUSY ??? END:VFREEBUSY\n(If your fhir server provides this information via calDAV, then you may want to include addressing information in a URL section, and with the search, a DTSTART and DTEND component can be included to indicate the range of time that has been covered in the collection of slots, where these overlap the resources period values. For all slots that reference this resource, include a FREEBUSY row for each slot)"
}
]
},
{
"path": "Schedule.identifier",
"short": "External Ids for this item",
"definition": "External Ids for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "UID"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Schedule.type",
"short": "The schedule type can be used for the categorization of healthcare services or other appointment types",
"definition": "The schedule type can be used for the categorization of healthcare services or other appointment types.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
},
"mapping": [
{
"identity": "ical",
"map": "n/a"
}
]
},
{
"path": "Schedule.actor",
"short": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson",
"definition": "The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "ATTENDEE:MAILTO:john_public@host2.com\nThis can be populated with a value from the referenced resource"
}
]
},
{
"path": "Schedule.planningHorizon",
"short": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates",
"definition": "The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a \"template\" for planning outside these dates.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "DTSTART:20131201T003000Z\nDTEND:2014030101T003000Z"
}
]
},
{
"path": "Schedule.comment",
"short": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated",
"definition": "Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "ical",
"map": "COMMENT:(comment)\nIf there is no comment, then the line can be excluded from the iCalendar entry"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "SearchParameter",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"name": "SearchParameter",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for SearchParameter Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "SearchParameter",
"short": "Search Parameter for a resource",
"definition": "A Search Parameter that defines a named search item that can be used to search/filter on a resource.",
"comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min": 1,
"max": "1",
"type": [
{
"code": "SearchParameter"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SearchParameter.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "SearchParameter.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "SearchParameter.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "SearchParameter.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "SearchParameter.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "SearchParameter.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SearchParameter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SearchParameter.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SearchParameter.url",
"short": "Literal URL used to reference this search parameter",
"definition": "An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements.",
"requirements": "To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "SearchParameter.name",
"short": "Name of search parameter",
"definition": "The name of the standard or custom search parameter.",
"comments": "This is the name to be used for this parameter in the search parameters in the URL.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the search parameter.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "SearchParameter.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SearchParameter.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SearchParameter.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SearchParameter.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the search parameter.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "SearchParameter.requirements",
"short": "Why this search parameter is defined",
"definition": "The Scope and Usage that this search parameter was created to meet.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.status",
"short": "draft | active | retired",
"definition": "The status of this search parameter definition.",
"comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "SearchParameter.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search parameter definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "SearchParameter.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the search parameter definition was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "SearchParameter.base",
"short": "The resource type this search parameter applies to",
"definition": "The base resource type that this search parameter refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "SearchParameter.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchParamType",
"strength": "required",
"description": "Data types allowed to be used for search parameters",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
},
{
"path": "SearchParameter.description",
"short": "Documentation for search parameter",
"definition": "A description of the search parameters and how it used.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.xpath",
"short": "XPath that extracts the values",
"definition": "An XPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them. E.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
}
]
},
"differential": {
"element": [
{
"path": "SearchParameter",
"short": "Search Parameter for a resource",
"definition": "A Search Parameter that defines a named search item that can be used to search/filter on a resource.",
"comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SearchParameter.url",
"short": "Literal URL used to reference this search parameter",
"definition": "An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements.",
"requirements": "To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "SearchParameter.name",
"short": "Name of search parameter",
"definition": "The name of the standard or custom search parameter.",
"comments": "This is the name to be used for this parameter in the search parameters in the URL.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the search parameter.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "SearchParameter.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the search parameter.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "SearchParameter.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "SearchParameter.requirements",
"short": "Why this search parameter is defined",
"definition": "The Scope and Usage that this search parameter was created to meet.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.status",
"short": "draft | active | retired",
"definition": "The status of this search parameter definition.",
"comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
}
},
{
"path": "SearchParameter.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search parameter definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "SearchParameter.date",
"short": "Publication Date(/time)",
"definition": "The date (and optionally time) when the search parameter definition was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "SearchParameter.base",
"short": "The resource type this search parameter applies to",
"definition": "The base resource type that this search parameter refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
},
{
"path": "SearchParameter.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SearchParamType",
"strength": "required",
"description": "Data types allowed to be used for search parameters",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/search-param-type"
}
}
},
{
"path": "SearchParameter.description",
"short": "Documentation for search parameter",
"definition": "A description of the search parameters and how it used.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.xpath",
"short": "XPath that extracts the values",
"definition": "An XPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them. E.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "SearchParameter.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "ResourceType",
"strength": "required",
"description": "One of the resource types defined as part of FHIR",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/resource-types"
}
}
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Slot",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Slot",
"name": "Slot",
"publisher": "HL7 FHIR Project (Patient Administration)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Slot Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "ical",
"uri": "http://www.ietf.org/rfc/rfc2445.txt",
"name": "iCalendar"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Slot",
"short": "A slot of time on a schedule that may be available for booking appointments",
"definition": "A slot of time on a schedule that may be available for booking appointments.",
"min": 1,
"max": "1",
"type": [
{
"code": "Slot"
}
],
"mapping": [
{
"identity": "ical",
"map": "(refer to the Availability resource for the header mapping details)"
}
]
},
{
"path": "Slot.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Slot.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Slot.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Slot.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Slot.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Slot.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Slot.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Slot.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Slot.identifier",
"short": "External Ids for this item",
"definition": "External Ids for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Slot.type",
"short": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource",
"definition": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
}
},
{
"path": "Slot.schedule",
"short": "The schedule resource that this slot defines an interval of status information",
"definition": "The schedule resource that this slot defines an interval of status information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Schedule"
}
],
"isSummary": true
},
{
"path": "Slot.freeBusyType",
"short": "BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE",
"definition": "BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "SlotStatus",
"strength": "required",
"description": "The free/busy status of a slot",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/slotstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z\nIf the freeBusyType is BUSY, then this value can be excluded"
}
]
},
{
"path": "Slot.start",
"short": "Date/Time that the slot is to begin",
"definition": "Date/Time that the slot is to begin.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z\nIf the freeBusyType is BUSY, then this value can be excluded"
}
]
},
{
"path": "Slot.end",
"short": "Date/Time that the slot is to conclude",
"definition": "Date/Time that the slot is to conclude.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY:19980314T233000Z/(end)\nIf the freeBusyType is BUSY, then this value can be excluded (as shown)"
}
]
},
{
"path": "Slot.overbooked",
"short": "This slot has already been overbooked, appointments are unlikely to be accepted for this time",
"definition": "This slot has already been overbooked, appointments are unlikely to be accepted for this time.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Slot.comment",
"short": "Comments on the slot to describe any extended information. Such as custom constraints on the slot",
"definition": "Comments on the slot to describe any extended information. Such as custom constraints on the slot.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Slot",
"short": "A slot of time on a schedule that may be available for booking appointments",
"definition": "A slot of time on a schedule that may be available for booking appointments.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "ical",
"map": "(refer to the Availability resource for the header mapping details)"
}
]
},
{
"path": "Slot.identifier",
"short": "External Ids for this item",
"definition": "External Ids for this item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Slot.type",
"short": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource",
"definition": "The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "DocumentC80PracticeSetting",
"strength": "preferred",
"description": "Additional details about where the content was created (e.g. clinical specialty)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/c80-practice-codes"
}
}
},
{
"path": "Slot.schedule",
"short": "The schedule resource that this slot defines an interval of status information",
"definition": "The schedule resource that this slot defines an interval of status information.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Schedule"
}
],
"isSummary": true
},
{
"path": "Slot.freeBusyType",
"short": "BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE",
"definition": "BUSY | FREE | BUSY-UNAVAILABLE | BUSY-TENTATIVE.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "SlotStatus",
"strength": "required",
"description": "The free/busy status of a slot",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/slotstatus"
}
},
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY;FBTYPE=(freeBusyType):19980314T233000Z/19980315T003000Z\nIf the freeBusyType is BUSY, then this value can be excluded"
}
]
},
{
"path": "Slot.start",
"short": "Date/Time that the slot is to begin",
"definition": "Date/Time that the slot is to begin.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY;FBTYPE=FREE:(start)/19980315T003000Z\nIf the freeBusyType is BUSY, then this value can be excluded"
}
]
},
{
"path": "Slot.end",
"short": "Date/Time that the slot is to conclude",
"definition": "Date/Time that the slot is to conclude.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "ical",
"map": "FREEBUSY:19980314T233000Z/(end)\nIf the freeBusyType is BUSY, then this value can be excluded (as shown)"
}
]
},
{
"path": "Slot.overbooked",
"short": "This slot has already been overbooked, appointments are unlikely to be accepted for this time",
"definition": "This slot has already been overbooked, appointments are unlikely to be accepted for this time.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Slot.comment",
"short": "Comments on the slot to describe any extended information. Such as custom constraints on the slot",
"definition": "Comments on the slot to describe any extended information. Such as custom constraints on the slot.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Specimen",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Specimen",
"name": "Specimen",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Specimen Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Specimen",
"short": "Sample for analysis",
"definition": "Sample for analysis.",
"min": 1,
"max": "1",
"type": [
{
"code": "Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
}
]
},
{
"path": "Specimen.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Specimen.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Specimen.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Specimen.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Specimen.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Specimen.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.identifier",
"short": "External Identifier",
"definition": "Id for specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-2"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Specimen.type",
"short": "Kind of material that forms the specimen",
"definition": "The kind of material that forms the specimen.",
"comments": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SpecimenType",
"strength": "example",
"description": "The type of the specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v2/vs/0487"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-4 and possibly SPM-5"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.parent",
"short": "Specimen from which this specimen originated",
"definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of a another specimen.",
"comments": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scoper (if parent)\n.player.scopesRole[classCode=SPEC].player (if child)"
}
]
},
{
"path": "Specimen.subject",
"short": "Where the specimen came from. This may be from the patient(s) or from the environment or a device",
"definition": "Where the specimen came from. This may be from the patient(s) or from the environment or a device.",
"requirements": "Must know the subject context.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scoper\n\nor\n\n.scoper.playsRole"
}
]
},
{
"path": "Specimen.accessionIdentifier",
"short": "Identifier assigned by the lab",
"definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-30 (v2.7+)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "Specimen.receivedTime",
"short": "The time when specimen was received for processing",
"definition": "Time when specimen was received for processing or testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-18"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
}
]
},
{
"path": "Specimen.collection",
"short": "Collection details",
"definition": "Details concerning the specimen collection.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "v2",
"map": "SPM-14"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.collection.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.collection.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.collection.collector",
"short": "Who collected the specimen",
"definition": "Person who collected the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Specimen.collection.comment",
"short": "Collector comments",
"definition": "To communicate any details or issues encountered during the specimen collection procedure.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Specimen.collection.collected[x]",
"short": "Collection time",
"definition": "Time when specimen was collected from subject - the physiologically relevant time.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-17"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Specimen.collection.quantity",
"short": "The quantity of specimen collected",
"definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-12"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}
]
},
{
"path": "Specimen.collection.method",
"short": "Technique used to perform collection",
"definition": "A coded value specifying the technique that is used to perform the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenCollectionMethod",
"strength": "example",
"description": "The technique that is used to perform the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-collection-method"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-7"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "Specimen.collection.bodySite[x]",
"short": "Anatomical collection site",
"definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-8 and SPM-9"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "Specimen.treatment",
"short": "Treatment and processing step details",
"definition": "Details concerning treatment and processing steps for the specimen.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.treatment.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.treatment.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.treatment.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.treatment.description",
"short": "Textual description of procedure",
"definition": "Textual description of procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Specimen.treatment.procedure",
"short": "Indicates the treatment or processing step applied to the specimen",
"definition": "A coded value specifying the procedure used to process the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenTreatmentProcedure",
"strength": "example",
"description": "Type indicating the technique used to process the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-treatment-procedure"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.treatment.additive",
"short": "Material used in the processing step",
"definition": "Material used in the processing step.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-6"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code"
}
]
},
{
"path": "Specimen.container",
"short": "Direct container of specimen (tube/slide, etc)",
"definition": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[classCode=CONT].scoper"
}
]
},
{
"path": "Specimen.container.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.container.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Specimen.container.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Specimen.container.identifier",
"short": "Id for the container",
"definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SAC-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Specimen.container.description",
"short": "Textual description of the container",
"definition": "Textual description of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".desc"
}
]
},
{
"path": "Specimen.container.type",
"short": "Kind of container directly associated with specimen",
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenContainerType",
"strength": "example",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-container-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-27"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.container.capacity",
"short": "Container volume or size",
"definition": "The capacity (volume or other measure) the container may contain.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Specimen.container.specimenQuantity",
"short": "Quantity of specimen within container",
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "SAC-23 (value) SAC-24 (units"
},
{
"identity": "rim",
"map": ".playedRole[classCode=CONT].quantity"
}
]
},
{
"path": "Specimen.container.additive[x]",
"short": "Additive associated with container",
"definition": "Introduced substance to preserve, maintain or enhance the specimen. examples: Formalin, Citrate, EDTA.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"name": "SpecimenContainerAdditive",
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v2/vs/0371"
}
},
"mapping": [
{
"identity": "v2",
"map": "SAC-27"
},
{
"identity": "rim",
"map": ".scopesRole[classCode=ADTV].player"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Specimen",
"short": "Sample for analysis",
"definition": "Sample for analysis.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Role[classCode=SPEC]"
}
]
},
{
"path": "Specimen.identifier",
"short": "External Identifier",
"definition": "Id for specimen.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-2"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Specimen.type",
"short": "Kind of material that forms the specimen",
"definition": "The kind of material that forms the specimen.",
"comments": "The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "SpecimenType",
"strength": "example",
"description": "The type of the specimen.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v2/vs/0487"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-4 and possibly SPM-5"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.parent",
"short": "Specimen from which this specimen originated",
"definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of a another specimen.",
"comments": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Specimen"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scoper (if parent)\n.player.scopesRole[classCode=SPEC].player (if child)"
}
]
},
{
"path": "Specimen.subject",
"short": "Where the specimen came from. This may be from the patient(s) or from the environment or a device",
"definition": "Where the specimen came from. This may be from the patient(s) or from the environment or a device.",
"requirements": "Must know the subject context.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".scoper\n\nor\n\n.scoper.playsRole"
}
]
},
{
"path": "Specimen.accessionIdentifier",
"short": "Identifier assigned by the lab",
"definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-30 (v2.7+)"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id"
}
]
},
{
"path": "Specimen.receivedTime",
"short": "The time when specimen was received for processing",
"definition": "Time when specimen was received for processing or testing.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-18"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime"
}
]
},
{
"path": "Specimen.collection",
"short": "Collection details",
"definition": "Details concerning the specimen collection.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "v2",
"map": "SPM-14"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.collection.collector",
"short": "Who collected the specimen",
"definition": "Person who collected the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRT"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Specimen.collection.comment",
"short": "Collector comments",
"definition": "To communicate any details or issues encountered during the specimen collection procedure.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"path": "Specimen.collection.collected[x]",
"short": "Collection time",
"definition": "Time when specimen was collected from subject - the physiologically relevant time.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SPM-17"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"path": "Specimen.collection.quantity",
"short": "The quantity of specimen collected",
"definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-12"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity"
}
]
},
{
"path": "Specimen.collection.method",
"short": "Technique used to perform collection",
"definition": "A coded value specifying the technique that is used to perform the procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenCollectionMethod",
"strength": "example",
"description": "The technique that is used to perform the procedure",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-collection-method"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-7"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"path": "Specimen.collection.bodySite[x]",
"short": "Anatomical collection site",
"definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/BodySite"
}
],
"binding": {
"name": "BodySite",
"strength": "example",
"description": "Codes describing anatomical locations. May include laterality",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-8 and SPM-9"
},
{
"identity": "rim",
"map": ".targetSiteCode"
}
]
},
{
"path": "Specimen.treatment",
"short": "Treatment and processing step details",
"definition": "Details concerning treatment and processing steps for the specimen.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]"
}
]
},
{
"path": "Specimen.treatment.description",
"short": "Textual description of procedure",
"definition": "Textual description of procedure.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"path": "Specimen.treatment.procedure",
"short": "Indicates the treatment or processing step applied to the specimen",
"definition": "A coded value specifying the procedure used to process the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenTreatmentProcedure",
"strength": "example",
"description": "Type indicating the technique used to process the specimen",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-treatment-procedure"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.treatment.additive",
"short": "Material used in the processing step",
"definition": "Material used in the processing step.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "v2",
"map": "SPM-6"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code"
}
]
},
{
"path": "Specimen.container",
"short": "Direct container of specimen (tube/slide, etc)",
"definition": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".player.scopingRole[classCode=CONT].scoper"
}
]
},
{
"path": "Specimen.container.identifier",
"short": "Id for the container",
"definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "SAC-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Specimen.container.description",
"short": "Textual description of the container",
"definition": "Textual description of the container.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".desc"
}
]
},
{
"path": "Specimen.container.type",
"short": "Kind of container directly associated with specimen",
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SpecimenContainerType",
"strength": "example",
"description": "Type of specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/specimen-container-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "SPM-27"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Specimen.container.capacity",
"short": "Container volume or size",
"definition": "The capacity (volume or other measure) the container may contain.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Specimen.container.specimenQuantity",
"short": "Quantity of specimen within container",
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "SAC-23 (value) SAC-24 (units"
},
{
"identity": "rim",
"map": ".playedRole[classCode=CONT].quantity"
}
]
},
{
"path": "Specimen.container.additive[x]",
"short": "Additive associated with container",
"definition": "Introduced substance to preserve, maintain or enhance the specimen. examples: Formalin, Citrate, EDTA.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"name": "SpecimenContainerAdditive",
"strength": "example",
"description": "Substance added to specimen container",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v2/vs/0371"
}
},
"mapping": [
{
"identity": "v2",
"map": "SAC-27"
},
{
"identity": "rim",
"map": ".scopesRole[classCode=ADTV].player"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "OperationDefinition",
"id": "StructureDefinition-questionnaire",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire",
"name": "Build Questionnaire",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Generates a [[[Questionnaire]]] instance based on a specified [[[StructureDefinition]]], creating questions for each core element or extension element found in the StructureDefinition. \n\nIf the operation is not called at the instance level, one of the *identifier*, *profile* or *url* 'in' parameters must be provided. (If called at the instance level, these parameters will be ignored. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice.)\n\nThe response will contain a [[[Questionnaire]]] instance based on the specified [[[StructureDefinition]]] and/or an [[[OperationOutcome]]] resource with errors or warnings.\n\nNested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as \"must support\" will be included.\n\nThis operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support \"non-core\" resources with minimal development effort.",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"kind": "operation",
"code": "questionnaire",
"notes": "**Open Issue**: Ideally, extensions should be populated in the generated [[[Questionnaire]]] that will support taking [[[QuestionnaireAnswers]]] resources generated from the Questionnaire and turning them back into the appropriate resources.",
"system": false,
"type": [
"StructureDefinition"
],
"instance": true,
"parameter": [
{
"name": "identifier",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A logical profile identifier (i.e. 'StructureDefinition.identifier''). The server must know the profile or be able to retrieve it from other known repositories.",
"type": "uri"
},
{
"name": "profile",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The [[[StructureDefinition]]] is provided directly as part of the request. Servers may choose not to accept profiles in this fashion",
"type": "token"
},
{
"name": "url",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The profile's official url (i.e. 'StructureDefinition.url'). The server must know the profile or be able to retrieve it from other known repositories.",
"type": "uri"
},
{
"name": "supportedOnly",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If true, the questionnaire will only include those elements marked as \"mustSupport='true'\" in the StructureDefinition.",
"type": "boolean"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The questionnaire form generated based on the StructureDefinition.",
"type": "Questionnaire"
}
]
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "StructureDefinition",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"name": "StructureDefinition",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for StructureDefinition Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "iso11179",
"uri": "http://metadata-standards.org/11179/",
"name": "ISO 11179"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "StructureDefinition",
"short": "Structural Definition",
"definition": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions, and constraints on resources and data types.",
"alias": [
"Template",
"Profile"
],
"min": 1,
"max": "1",
"type": [
{
"code": "StructureDefinition"
}
],
"constraint": [
{
"key": "sdf-5",
"severity": "error",
"human": "If the type is 'extension' then the structure must have context information",
"xpath": "not(f:type/@value = 'extension') or (f:context and f:contextType)"
},
{
"key": "sdf-4",
"severity": "error",
"human": "A structure must have a base unless it’s type is 'abstract'",
"xpath": "(f:type/@value = 'abstract') or f:base"
},
{
"key": "sdf-7",
"severity": "error",
"human": "If the type is Resource or Type, the url has to start with \"http://hl7.org/fhir/StructureDefinition/\" and the tail must match the name",
"xpath": "not(f:type/@value=('Resource', 'Type')) or f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:name/@value)"
},
{
"key": "sdf-6",
"severity": "error",
"human": "A structure must have either a differential, or a snapshot (or both)",
"xpath": "f:snapshot or f:differential"
},
{
"key": "sdf-8",
"severity": "error",
"human": "In any snapshot or differential, all the elements except the first have to have a path that starts with the path of the first + \".\"",
"xpath": "string-join(for $elementName in f:*[self::f:snapshot or self::f:differential]/f:element[position()>1]/f:path/@value return if (starts-with($elementName, concat($elementName/ancestor::f:element/parent::f:*/f:element[1]/f:path/@value, '.'))) then '' else $elementName,'')=''"
}
]
},
{
"path": "StructureDefinition.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "StructureDefinition.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "StructureDefinition.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "StructureDefinition.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "StructureDefinition.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "StructureDefinition.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.url",
"short": "Literal URL used to reference this StructureDefinition",
"definition": "An absolute URL at which this StructureDefinition is (or will be) published, and which is used to reference this StructureDefinition in extension urls and tag values in operational FHIR systems.",
"requirements": "So you can say, in a StructureDefinition, what the full extensions URLs should be. This is required to allow hosting StructureDefinitions on multiple different servers, and to allow for the editorial process.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.identifier",
"short": "Other identifiers for the StructureDefinition",
"definition": "Formal identifier that is used to identify this StructureDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).",
"comments": "N/A.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Identifier part"
}
]
},
{
"path": "StructureDefinition.version",
"short": "Logical id for this version of the StructureDefinition",
"definition": "The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.",
"comments": "N/A.",
"requirements": "There may be multiple resource versions of the StructureDefinition that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Version"
}
]
},
{
"path": "StructureDefinition.name",
"short": "Informal name for this StructureDefinition",
"definition": "A free text natural language name identifying the StructureDefinition.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.useContext",
"short": "Content intends to support these contexts",
"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 of structure definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "iso11179",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
}
]
},
{
"path": "StructureDefinition.display",
"short": "Use this name when displaying the value",
"definition": "Defined so that applications can use this name when displaying the value of the extension to the user.",
"comments": "Applications don't have to use this name, but can always fall back to it. In the absence of a value for this element, use the name.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the structure definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Registration Authority"
}
]
},
{
"path": "StructureDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "StructureDefinition.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.contact.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.contact.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the structure definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.description",
"short": "Natural language description of the StructureDefinition",
"definition": "A free text natural language description of the StructureDefinition and its use.",
"comments": "This field can be used for things such as why the StructureDefinition was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the StructureDefinition as conveyed in StructureDefinition.text. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.requirements",
"short": "Scope and Usage this structure definition is for",
"definition": "Explains why this structure definition is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the structure definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.code",
"short": "Assist with indexing and finding",
"definition": "A set of terms from external terminologies that may be used to assist with indexing and searching of templates.",
"requirements": "Assist in searching for appropriate StructureDefinitions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "keywords"
}
]
},
{
"path": "StructureDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the StructureDefinition.",
"requirements": "Allows filtering of StructureDefinitions that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"path": "StructureDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of StructureDefinitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"path": "StructureDefinition.date",
"short": "Date for this version of the StructureDefinition",
"definition": "The date that this version of the StructureDefinition was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.fhirVersion",
"short": "FHIR Version this StructureDefinition targets",
"definition": "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 0.4.0 for this version.",
"comments": "A StructureDefinition does not need to specify the target it applies to,as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.mapping",
"short": "External specification that the content is mapped to",
"definition": "An external specification that the content is mapped to.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "sdf-2",
"severity": "error",
"human": "Must have at a name or a uri (or both)",
"xpath": "exists(f:uri) or exists(f:name)"
}
]
},
{
"path": "StructureDefinition.mapping.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.mapping.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.mapping.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "StructureDefinition.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-2"
]
},
{
"path": "StructureDefinition.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-2"
]
},
{
"path": "StructureDefinition.mapping.comments",
"short": "Versions, Issues, Scope limitations etc",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.type",
"short": "type | resource | constraint | extension",
"definition": "Defines the type of structure that this definition is describing.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "StructureDefinitionType",
"strength": "required",
"description": "Defines the type of structure that a definition is describing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/structure-definition-type"
}
}
},
{
"path": "StructureDefinition.abstract",
"short": "Whether the structure is abstract",
"definition": "Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.",
"comments": "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the profile, but have children described, are anonymous concrete types that specialise Element.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.contextType",
"short": "resource | datatype | mapping | extension",
"definition": "If this is an extension, Identifies the context within FHIR resources where the extension can be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"sdf-5"
],
"isSummary": true,
"binding": {
"name": "ExtensionContext",
"strength": "required",
"description": "How an extension context is interpreted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/extension-context"
}
}
},
{
"path": "StructureDefinition.context",
"short": "Where the extension can be used in instances",
"definition": "Identifies the types of resource or data type elements to which the extension can be applied.",
"comments": "If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of \"string\" doesn't mean that the extension can be used with one of the string patterns such as \"id\" etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-5"
],
"isSummary": true
},
{
"path": "StructureDefinition.base",
"short": "Structure that this set of constraints applies to",
"definition": "An absolute URI that is the base structure from which this set of constraints is derived.",
"comments": "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snaphots from differential constraints.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-4"
],
"isSummary": true
},
{
"path": "StructureDefinition.snapshot",
"short": "Snapshot view of the structure",
"definition": "A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.",
"min": 0,
"max": "1",
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "sdf-1",
"severity": "error",
"human": "Element paths must be unique - or not (LM)",
"xpath": "count(f:element) >= count(distinct-values(f:element/f:path/@value))"
},
{
"key": "sdf-3",
"severity": "error",
"human": "If a structure is a snapshot, then each element definition must have a formal definition, and cardinalities",
"xpath": "exists(f:base) or (count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)]))"
}
]
},
{
"path": "StructureDefinition.snapshot.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.snapshot.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.snapshot.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.snapshot.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"condition": [
"sdf-3"
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
},
{
"path": "StructureDefinition.differential",
"short": "Differential view of the structure",
"definition": "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min": 0,
"max": "1",
"condition": [
"sdf-6"
]
},
{
"path": "StructureDefinition.differential.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.differential.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "StructureDefinition.differential.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "StructureDefinition.differential.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
}
]
},
"differential": {
"element": [
{
"path": "StructureDefinition",
"short": "Structural Definition",
"definition": "A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions, and constraints on resources and data types.",
"alias": [
"Template",
"Profile"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"constraint": [
{
"key": "sdf-5",
"severity": "error",
"human": "If the type is 'extension' then the structure must have context information",
"xpath": "not(f:type/@value = 'extension') or (f:context and f:contextType)"
},
{
"key": "sdf-4",
"severity": "error",
"human": "A structure must have a base unless it’s type is 'abstract'",
"xpath": "(f:type/@value = 'abstract') or f:base"
},
{
"key": "sdf-7",
"severity": "error",
"human": "If the type is Resource or Type, the url has to start with \"http://hl7.org/fhir/StructureDefinition/\" and the tail must match the name",
"xpath": "not(f:type/@value=('Resource', 'Type')) or f:url/@value=concat('http://hl7.org/fhir/StructureDefinition/', f:name/@value)"
},
{
"key": "sdf-6",
"severity": "error",
"human": "A structure must have either a differential, or a snapshot (or both)",
"xpath": "f:snapshot or f:differential"
},
{
"key": "sdf-8",
"severity": "error",
"human": "In any snapshot or differential, all the elements except the first have to have a path that starts with the path of the first + \".\"",
"xpath": "string-join(for $elementName in f:*[self::f:snapshot or self::f:differential]/f:element[position()>1]/f:path/@value return if (starts-with($elementName, concat($elementName/ancestor::f:element/parent::f:*/f:element[1]/f:path/@value, '.'))) then '' else $elementName,'')=''"
}
]
},
{
"path": "StructureDefinition.url",
"short": "Literal URL used to reference this StructureDefinition",
"definition": "An absolute URL at which this StructureDefinition is (or will be) published, and which is used to reference this StructureDefinition in extension urls and tag values in operational FHIR systems.",
"requirements": "So you can say, in a StructureDefinition, what the full extensions URLs should be. This is required to allow hosting StructureDefinitions on multiple different servers, and to allow for the editorial process.",
"alias": [
"url",
"authoritative-url",
"destination",
"identity"
],
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.identifier",
"short": "Other identifiers for the StructureDefinition",
"definition": "Formal identifier that is used to identify this StructureDefinition when it is represented in other formats, or referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI), (if it's not possible to use the literal URI).",
"comments": "N/A.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Identifier part"
}
]
},
{
"path": "StructureDefinition.version",
"short": "Logical id for this version of the StructureDefinition",
"definition": "The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually.",
"comments": "N/A.",
"requirements": "There may be multiple resource versions of the StructureDefinition that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Version"
}
]
},
{
"path": "StructureDefinition.name",
"short": "Informal name for this StructureDefinition",
"definition": "A free text natural language name identifying the StructureDefinition.",
"comments": "Not expected to be globally unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.useContext",
"short": "Content intends to support these contexts",
"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 of structure definitions.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "iso11179",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
}
]
},
{
"path": "StructureDefinition.display",
"short": "Use this name when displaying the value",
"definition": "Defined so that applications can use this name when displaying the value of the extension to the user.",
"comments": "Applications don't have to use this name, but can always fall back to it. In the absence of a value for this element, use the name.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the structure definition.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the structure definition. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Registration Authority"
}
]
},
{
"path": "StructureDefinition.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"isSummary": true
},
{
"path": "StructureDefinition.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the structure definition.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.description",
"short": "Natural language description of the StructureDefinition",
"definition": "A free text natural language description of the StructureDefinition and its use.",
"comments": "This field can be used for things such as why the StructureDefinition was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is *not* a rendering of the StructureDefinition as conveyed in StructureDefinition.text. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.requirements",
"short": "Scope and Usage this structure definition is for",
"definition": "Explains why this structure definition is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the structure definition (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.code",
"short": "Assist with indexing and finding",
"definition": "A set of terms from external terminologies that may be used to assist with indexing and searching of templates.",
"requirements": "Assist in searching for appropriate StructureDefinitions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "keywords"
}
]
},
{
"path": "StructureDefinition.status",
"short": "draft | active | retired",
"definition": "The status of the StructureDefinition.",
"requirements": "Allows filtering of StructureDefinitions that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"path": "StructureDefinition.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This StructureDefinition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"requirements": "Allows filtering of StructureDefinitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "iso11179",
"map": "Registration status"
}
]
},
{
"path": "StructureDefinition.date",
"short": "Date for this version of the StructureDefinition",
"definition": "The date that this version of the StructureDefinition was published.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.fhirVersion",
"short": "FHIR Version this StructureDefinition targets",
"definition": "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 0.4.0 for this version.",
"comments": "A StructureDefinition does not need to specify the target it applies to,as StructureDefinitions will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a StructureDefinition is consistent with a particular StructureDefinition if desired.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.mapping",
"short": "External specification that the content is mapped to",
"definition": "An external specification that the content is mapped to.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "sdf-2",
"severity": "error",
"human": "Must have at a name or a uri (or both)",
"xpath": "exists(f:uri) or exists(f:name)"
}
]
},
{
"path": "StructureDefinition.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An Internal id that is used to identify this mapping set when specific mappings are made.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "StructureDefinition.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-2"
]
},
{
"path": "StructureDefinition.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-2"
]
},
{
"path": "StructureDefinition.mapping.comments",
"short": "Versions, Issues, Scope limitations etc",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "StructureDefinition.type",
"short": "type | resource | constraint | extension",
"definition": "Defines the type of structure that this definition is describing.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "StructureDefinitionType",
"strength": "required",
"description": "Defines the type of structure that a definition is describing",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/structure-definition-type"
}
}
},
{
"path": "StructureDefinition.abstract",
"short": "Whether the structure is abstract",
"definition": "Whether structure this definition describes is abstract or not - that is, whether an actual exchanged item can ever be of this type.",
"comments": "Abstract Resources cannot be instantiated - a concrete sub-type must be used. Abstract datatypes and extensions cannot be used in an instance. Flagging a constraint structure as abstract conveys design intent but makes no difference to how the structure definition is handled. Note that inline declared elements that are given the type \"Element\" in the profile, but have children described, are anonymous concrete types that specialise Element.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "StructureDefinition.contextType",
"short": "resource | datatype | mapping | extension",
"definition": "If this is an extension, Identifies the context within FHIR resources where the extension can be used.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"sdf-5"
],
"isSummary": true,
"binding": {
"name": "ExtensionContext",
"strength": "required",
"description": "How an extension context is interpreted",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/extension-context"
}
}
},
{
"path": "StructureDefinition.context",
"short": "Where the extension can be used in instances",
"definition": "Identifies the types of resource or data type elements to which the extension can be applied.",
"comments": "If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of \"string\" doesn't mean that the extension can be used with one of the string patterns such as \"id\" etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
],
"condition": [
"sdf-5"
],
"isSummary": true
},
{
"path": "StructureDefinition.base",
"short": "Structure that this set of constraints applies to",
"definition": "An absolute URI that is the base structure from which this set of constraints is derived.",
"comments": "If differential constraints are specified in this structure, they are applied to the base in a \"differential\" fashion. If there is no base, then the differential constraints cannot be provided (snapshot only). Differential structures are useful for the editing perspective, and snapshot structures are suitable for operational use. The FHIR Project provides a number of tools/services to populate snaphots from differential constraints.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"condition": [
"sdf-4"
],
"isSummary": true
},
{
"path": "StructureDefinition.snapshot",
"short": "Snapshot view of the structure",
"definition": "A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.",
"min": 0,
"max": "1",
"condition": [
"sdf-6"
],
"constraint": [
{
"key": "sdf-1",
"severity": "error",
"human": "Element paths must be unique - or not (LM)",
"xpath": "count(f:element) >= count(distinct-values(f:element/f:path/@value))"
},
{
"key": "sdf-3",
"severity": "error",
"human": "If a structure is a snapshot, then each element definition must have a formal definition, and cardinalities",
"xpath": "exists(f:base) or (count(f:element) = count(f:element[exists(f:definition) and exists(f:min) and exists(f:max)]))"
}
]
},
{
"path": "StructureDefinition.snapshot.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"condition": [
"sdf-3"
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
},
{
"path": "StructureDefinition.differential",
"short": "Differential view of the structure",
"definition": "A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.",
"min": 0,
"max": "1",
"condition": [
"sdf-6"
]
},
{
"path": "StructureDefinition.differential.element",
"short": "Definition of elements in the resource (if no StructureDefinition)",
"definition": "Captures constraints on each element within the resource.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mapping": [
{
"identity": "iso11179",
"map": "--"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Subscription",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Subscription",
"name": "Subscription",
"publisher": "HL7 FHIR Project (FHIR Management Group)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Subscription Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Subscription",
"short": "A server push subscription criteria",
"definition": "The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system is able to take an appropriate action.",
"alias": [
"WebHook",
"Hook",
"Routing Rule"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Subscription"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Subscription.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Subscription.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Subscription.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Subscription.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Subscription.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.criteria",
"short": "Rule for server push criteria",
"definition": "The rules that the server should use to determine when to generate notifications for this subscription.",
"comments": "The rules are a search criteria (without the [base] part.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.contact",
"short": "Contact details for source (e.g. troubleshooting)",
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
]
},
{
"path": "Subscription.reason",
"short": "Description of why this subscription was created",
"definition": "A description of why this subscription is defined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.status",
"short": "requested | active | error | off",
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"comments": "A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SubscriptionStatus",
"strength": "required",
"description": "The status of a subscription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/subscription-status"
}
}
},
{
"path": "Subscription.error",
"short": "Latest error note",
"definition": "A record of the last error that occurred when the server processed a notification.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.channel",
"short": "The channel on which to report matches to the criteria",
"definition": "Details where to send notifications when resources are received that meet the criteria.",
"min": 1,
"max": "1"
},
{
"path": "Subscription.channel.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Subscription.channel.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Subscription.channel.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.channel.type",
"short": "rest-hook | websocket | email | sms | message",
"definition": "The type of channel to send notififcations on.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SubscriptionChannelType",
"strength": "required",
"description": "The type of method used to execute a subscription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/subscription-channel-type"
}
}
},
{
"path": "Subscription.channel.endpoint",
"short": "Where the channel points to",
"definition": "The uri that describes tha actual end point to send messages to.",
"comments": "For rest-hook, and websocket, the end point must be an http: or https URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Subscription.channel.payload",
"short": "Mimetype to send, or blank for no payload",
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification.",
"comments": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.channel.header",
"short": "Usage depends on the channel type",
"definition": "Additional headers / information to send as part of the notification.",
"comments": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.end",
"short": "When to automatically delete the subscription",
"definition": "The time for the server to turn the subscription off.",
"comments": "The server is permitted to deviate from this time, but should observe it.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Subscription.tag",
"short": "A tag to add to matching resources",
"definition": "A tag to add to any resource that matches the criteria, after the subscription is processed.",
"comments": "So that other systems can tell which resources have been the subject of a notification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Subscription",
"short": "A server push subscription criteria",
"definition": "The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system is able to take an appropriate action.",
"alias": [
"WebHook",
"Hook",
"Routing Rule"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Subscription.criteria",
"short": "Rule for server push criteria",
"definition": "The rules that the server should use to determine when to generate notifications for this subscription.",
"comments": "The rules are a search criteria (without the [base] part.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.contact",
"short": "Contact details for source (e.g. troubleshooting)",
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
]
},
{
"path": "Subscription.reason",
"short": "Description of why this subscription was created",
"definition": "A description of why this subscription is defined.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.status",
"short": "requested | active | error | off",
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"comments": "A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SubscriptionStatus",
"strength": "required",
"description": "The status of a subscription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/subscription-status"
}
}
},
{
"path": "Subscription.error",
"short": "Latest error note",
"definition": "A record of the last error that occurred when the server processed a notification.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.channel",
"short": "The channel on which to report matches to the criteria",
"definition": "Details where to send notifications when resources are received that meet the criteria.",
"min": 1,
"max": "1"
},
{
"path": "Subscription.channel.type",
"short": "rest-hook | websocket | email | sms | message",
"definition": "The type of channel to send notififcations on.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "SubscriptionChannelType",
"strength": "required",
"description": "The type of method used to execute a subscription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/subscription-channel-type"
}
}
},
{
"path": "Subscription.channel.endpoint",
"short": "Where the channel points to",
"definition": "The uri that describes tha actual end point to send messages to.",
"comments": "For rest-hook, and websocket, the end point must be an http: or https URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "Subscription.channel.payload",
"short": "Mimetype to send, or blank for no payload",
"definition": "The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification.",
"comments": "Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.channel.header",
"short": "Usage depends on the channel type",
"definition": "Additional headers / information to send as part of the notification.",
"comments": "Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Subscription.end",
"short": "When to automatically delete the subscription",
"definition": "The time for the server to turn the subscription off.",
"comments": "The server is permitted to deviate from this time, but should observe it.",
"min": 0,
"max": "1",
"type": [
{
"code": "instant"
}
]
},
{
"path": "Subscription.tag",
"short": "A tag to add to matching resources",
"definition": "A tag to add to any resource that matches the criteria, after the subscription is processed.",
"comments": "So that other systems can tell which resources have been the subject of a notification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Substance",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Substance",
"name": "Substance",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Substance Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Substance",
"short": "A homogeneous material with a definite composition",
"definition": "A homogeneous material with a definite composition.",
"min": 1,
"max": "1",
"type": [
{
"code": "Substance"
}
],
"mapping": [
{
"identity": "rim",
"map": "Material"
}
]
},
{
"path": "Substance.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Substance.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Substance.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Substance.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Substance.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Substance.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Substance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Substance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Substance.type",
"short": "What kind of substance this is",
"definition": "A code (or set of codes) that identify this substance.",
"comments": "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Substance.description",
"short": "Textual description of the substance, comments",
"definition": "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.desc"
}
]
},
{
"path": "Substance.instance",
"short": "If this describes a specific package/container of the substance",
"definition": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player.determinerCode"
}
]
},
{
"path": "Substance.instance.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Substance.instance.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Substance.instance.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Substance.instance.identifier",
"short": "Identifier of the package/container",
"definition": "Identifier associated with the package/container (usually a label affixed directly).",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Substance.instance.expiry",
"short": "When no longer valid to use",
"definition": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".expiryTime"
}
]
},
{
"path": "Substance.instance.quantity",
"short": "Amount of substance in the package",
"definition": "The amount of the substance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.quantity"
}
]
},
{
"path": "Substance.ingredient",
"short": "Composition information about the substance",
"definition": "A substance can be composed of other substances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".player.scopesRole[classCode=INGR]"
}
]
},
{
"path": "Substance.ingredient.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Substance.ingredient.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Substance.ingredient.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Substance.ingredient.quantity",
"short": "Optional amount (concentration)",
"definition": "The amount of the ingredient in the substance - a concentration ratio.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Substance.ingredient.substance",
"short": "A component of the substance",
"definition": "Another substance that is a component of this substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Substance",
"short": "A homogeneous material with a definite composition",
"definition": "A homogeneous material with a definite composition.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Material"
}
]
},
{
"path": "Substance.type",
"short": "What kind of substance this is",
"definition": "A code (or set of codes) that identify this substance.",
"comments": "This could be a reference to an externally defined code. It could also be a locally assigned code (e.g. a formulary), optionally with translations to the standard drug codes.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SubstanceType",
"strength": "example",
"description": "Type of the substance",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/substance-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Substance.description",
"short": "Textual description of the substance, comments",
"definition": "A description of the substance - its appearance, handling requirements, and other usage notes.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.desc"
}
]
},
{
"path": "Substance.instance",
"short": "If this describes a specific package/container of the substance",
"definition": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player.determinerCode"
}
]
},
{
"path": "Substance.instance.identifier",
"short": "Identifier of the package/container",
"definition": "Identifier associated with the package/container (usually a label affixed directly).",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Substance.instance.expiry",
"short": "When no longer valid to use",
"definition": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".expiryTime"
}
]
},
{
"path": "Substance.instance.quantity",
"short": "Amount of substance in the package",
"definition": "The amount of the substance.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.quantity"
}
]
},
{
"path": "Substance.ingredient",
"short": "Composition information about the substance",
"definition": "A substance can be composed of other substances.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".player.scopesRole[classCode=INGR]"
}
]
},
{
"path": "Substance.ingredient.quantity",
"short": "Optional amount (concentration)",
"definition": "The amount of the ingredient in the substance - a concentration ratio.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Substance.ingredient.substance",
"short": "A component of the substance",
"definition": "Another substance that is a component of this substance.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "Supply",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Supply",
"name": "Supply",
"publisher": "HL7 FHIR Project (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Supply Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Supply",
"short": "A supply - request and provision",
"definition": "A supply - a request for something, and provision of what is supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "Supply"
}
],
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=RQO]"
}
]
},
{
"path": "Supply.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Supply.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Supply.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Supply.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Supply.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Supply.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Supply.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Supply.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Supply.kind",
"short": "The kind of supply (central, non-stock, etc)",
"definition": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SupplyKind",
"strength": "required",
"description": "Category of supply",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supply-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Supply.identifier",
"short": "Unique identifier",
"definition": "Unique identifier for this supply request.",
"comments": "This is assigned by the orderer, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Supply.status",
"short": "requested | dispensed | received | failed | cancelled",
"definition": "Status of the supply request.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SupplyStatus",
"strength": "required",
"description": "Status of the supply",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
},
{
"path": "Supply.orderedItem",
"short": "Medication, Substance, or Device requested to be supplied",
"definition": "The item that is requested to be supplied.",
"comments": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "Supply.patient",
"short": "Patient for whom the item is supplied",
"definition": "A link to a resource representing the person whom the ordered item is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "Supply.dispense",
"short": "Supply details",
"definition": "Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source[classCode=SPLY, moodCode=EVN]"
}
]
},
{
"path": "Supply.dispense.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Supply.dispense.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Supply.dispense.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Supply.dispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility when the item(s) is dispensed.",
"comments": "This is assigned by the dispenser, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Supply.dispense.status",
"short": "in-progress | dispensed | abandoned",
"definition": "A code specifying the state of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SupplyDispenseStatus",
"strength": "required",
"description": "Status of the dispense",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
},
{
"path": "Supply.dispense.type",
"short": "Category of dispense event",
"definition": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SupplyItemType",
"strength": "required",
"description": "The actual item being supplied",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supply-item"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Supply.dispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of supply that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Supply.dispense.suppliedItem",
"short": "Medication, Substance, or Device supplied",
"definition": "Identifies the medication or substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "Supply.dispense.supplier",
"short": "Dispenser",
"definition": "The individual responsible for dispensing the medication, supplier or device.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Supply.dispense.whenPrepared",
"short": "Dispensing time",
"definition": "The time the dispense event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low"
}
]
},
{
"path": "Supply.dispense.whenHandedOver",
"short": "Handover time",
"definition": "The time the dispensed item was sent or handed to the patient (or agent).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high"
}
]
},
{
"path": "Supply.dispense.destination",
"short": "Where the Supply was sent",
"definition": "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"path": "Supply.dispense.receiver",
"short": "Who collected the Supply",
"definition": "Identifies the person who picked up the Supply.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Supply",
"short": "A supply - request and provision",
"definition": "A supply - a request for something, and provision of what is supplied.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=RQO]"
}
]
},
{
"path": "Supply.kind",
"short": "The kind of supply (central, non-stock, etc)",
"definition": "Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SupplyKind",
"strength": "required",
"description": "Category of supply",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supply-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Supply.identifier",
"short": "Unique identifier",
"definition": "Unique identifier for this supply request.",
"comments": "This is assigned by the orderer, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Supply.status",
"short": "requested | dispensed | received | failed | cancelled",
"definition": "Status of the supply request.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SupplyStatus",
"strength": "required",
"description": "Status of the supply",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
},
{
"path": "Supply.orderedItem",
"short": "Medication, Substance, or Device requested to be supplied",
"definition": "The item that is requested to be supplied.",
"comments": "Note that there's a difference between a prescription - an instruction to take a medication, along with a (sometimes) implicit supply, and an explicit request to supply, with no explicit instructions.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "Supply.patient",
"short": "Patient for whom the item is supplied",
"definition": "A link to a resource representing the person whom the ordered item is for.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role"
}
]
},
{
"path": "Supply.dispense",
"short": "Supply details",
"definition": "Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source[classCode=SPLY, moodCode=EVN]"
}
]
},
{
"path": "Supply.dispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility when the item(s) is dispensed.",
"comments": "This is assigned by the dispenser, and used to refer to this order in other external standards.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
},
{
"path": "Supply.dispense.status",
"short": "in-progress | dispensed | abandoned",
"definition": "A code specifying the state of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "SupplyDispenseStatus",
"strength": "required",
"description": "Status of the dispense",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/valueset-supply-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode, also existence of fulfillment events"
}
]
},
{
"path": "Supply.dispense.type",
"short": "Category of dispense event",
"definition": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "SupplyItemType",
"strength": "required",
"description": "The actual item being supplied",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/supply-item"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Supply.dispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of supply that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Supply.dispense.suppliedItem",
"short": "Medication, Substance, or Device supplied",
"definition": "Identifies the medication or substance or device being dispensed. This is either a link to a resource representing the details of the item or a simple attribute carrying a code that identifies the item from a known list.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"path": "Supply.dispense.supplier",
"short": "Dispenser",
"definition": "The individual responsible for dispensing the medication, supplier or device.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role"
}
]
},
{
"path": "Supply.dispense.whenPrepared",
"short": "Dispensing time",
"definition": "The time the dispense event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.low"
}
]
},
{
"path": "Supply.dispense.whenHandedOver",
"short": "Handover time",
"definition": "The time the dispensed item was sent or handed to the patient (or agent).",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime.high"
}
]
},
{
"path": "Supply.dispense.destination",
"short": "Where the Supply was sent",
"definition": "Identification of the facility/location where the Supply was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"path": "Supply.dispense.receiver",
"short": "Who collected the Supply",
"definition": "Identifies the person who picked up the Supply.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "SupportingDocumentation",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/SupportingDocumentation",
"name": "SupportingDocumentation",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for SupportingDocumentation Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "SupportingDocumentation",
"short": "Documentation submission",
"definition": "This resource provides the supporting information for a process, for example clinical or financial information related to a claim or pre-authorization.",
"alias": [
"Attachments\nSupporting Information"
],
"min": 1,
"max": "1",
"type": [
{
"code": "SupportingDocumentation"
}
]
},
{
"path": "SupportingDocumentation.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "SupportingDocumentation.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "SupportingDocumentation.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "SupportingDocumentation.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "SupportingDocumentation.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "SupportingDocumentation.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SupportingDocumentation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SupportingDocumentation.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SupportingDocumentation.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 1,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "SupportingDocumentation.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "SupportingDocumentation.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "SupportingDocumentation.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "SupportingDocumentation.target",
"short": "Insurer or Provider",
"definition": "The Insurer, organization or Provider who is target of the submission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "SupportingDocumentation.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "SupportingDocumentation.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "SupportingDocumentation.request",
"short": "Request reference",
"definition": "Original request.",
"comments": "changed name from number to identifier.",
"alias": [
"Transaction Reference Number"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02"
}
]
},
{
"path": "SupportingDocumentation.response",
"short": "Response reference",
"definition": "Original response.",
"comments": "changed name from number to identifier.",
"alias": [
"Transaction Reference Number"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G01"
}
]
},
{
"path": "SupportingDocumentation.author",
"short": "Author",
"definition": "Person who created the submission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "SupportingDocumentation.subject",
"short": "Patient",
"definition": "The patient who is directly or indirectly the subject of the supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "right"
}
],
"path": "SupportingDocumentation.detail",
"short": "Supporting Files",
"definition": "Supporting Files.",
"min": 0,
"max": "*"
},
{
"path": "SupportingDocumentation.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SupportingDocumentation.detail.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "SupportingDocumentation.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "SupportingDocumentation.detail.linkId",
"short": "LinkId",
"definition": "A link Id for the response to reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "SupportingDocumentation.detail.content[x]",
"short": "Content",
"definition": "The attached content.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
},
{
"code": "Attachment"
}
]
},
{
"path": "SupportingDocumentation.detail.dateTime",
"short": "Creation date and time",
"definition": "The date and optionally time when the material was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
},
"differential": {
"element": [
{
"path": "SupportingDocumentation",
"short": "Documentation submission",
"definition": "This resource provides the supporting information for a process, for example clinical or financial information related to a claim or pre-authorization.",
"alias": [
"Attachments\nSupporting Information"
],
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
]
},
{
"path": "SupportingDocumentation.identifier",
"short": "Business Identifier",
"definition": "The Response Business Identifier.",
"min": 1,
"max": "*",
"type": [
{
"code": "Identifier"
}
]
},
{
"path": "SupportingDocumentation.ruleset",
"short": "Resource version",
"definition": "The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "SupportingDocumentation.originalRuleset",
"short": "Original version",
"definition": "The style (standard) and version of the original material which was converted into this resource.",
"requirements": "Knowledge of the original version can inform the processing of this instance so that information which is processable by the originating system may be generated.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "Ruleset",
"strength": "example",
"description": "The static and dynamic model to which contents conform, may be business version or standard and version.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/ruleset"
}
}
},
{
"path": "SupportingDocumentation.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "SupportingDocumentation.target",
"short": "Insurer or Provider",
"definition": "The Insurer, organization or Provider who is target of the submission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "SupportingDocumentation.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "B01"
}
]
},
{
"path": "SupportingDocumentation.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
]
},
{
"path": "SupportingDocumentation.request",
"short": "Request reference",
"definition": "Original request.",
"comments": "changed name from number to identifier.",
"alias": [
"Transaction Reference Number"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "A02"
}
]
},
{
"path": "SupportingDocumentation.response",
"short": "Response reference",
"definition": "Original response.",
"comments": "changed name from number to identifier.",
"alias": [
"Transaction Reference Number"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "cdanetv4",
"map": "G01"
}
]
},
{
"path": "SupportingDocumentation.author",
"short": "Author",
"definition": "Person who created the submission.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
]
},
{
"path": "SupportingDocumentation.subject",
"short": "Patient",
"definition": "The patient who is directly or indirectly the subject of the supporting information.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint",
"valueString": "right"
}
],
"path": "SupportingDocumentation.detail",
"short": "Supporting Files",
"definition": "Supporting Files.",
"min": 0,
"max": "*"
},
{
"path": "SupportingDocumentation.detail.linkId",
"short": "LinkId",
"definition": "A link Id for the response to reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "SupportingDocumentation.detail.content[x]",
"short": "Content",
"definition": "The attached content.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
},
{
"code": "Attachment"
}
]
},
{
"path": "SupportingDocumentation.detail.dateTime",
"short": "Creation date and time",
"definition": "The date and optionally time when the material was created.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
}
}
},
{
"resource": {
"resourceType": "StructureDefinition",
"id": "VisionPrescription",
"meta": {
"lastUpdated": "2015-03-27T00:13:00.999+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/VisionPrescription",
"name": "VisionPrescription",
"publisher": "HL7 FHIR Project (Financial Management)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fm/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for VisionPrescription Resource",
"status": "draft",
"date": "2015-03-27T00:13:00+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "VisionPrescription",
"short": "Prescription for Vision correction products for a patient",
"definition": "An authorization for the supply of glasses and/or contact lenses to a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "VisionPrescription"
}
],
"mapping": [
{
"identity": "rim",
"map": "CombinedVisionRequest"
}
]
},
{
"path": "VisionPrescription.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "VisionPrescription.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 may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "VisionPrescription.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.",
"comments": "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 as much as possible.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "VisionPrescription.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "VisionPrescription.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "VisionPrescription.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.",
"comments": "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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "VisionPrescription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "VisionPrescription.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "VisionPrescription.identifier",
"short": "Business identifier",
"definition": "Business identifier which may be used by other parties to reference or identify the prescription.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "VisionPrescription.dateWritten",
"short": "When prescription was authorized",
"definition": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "VisionPrescription.patient",
"short": "Who prescription is for",
"definition": "A link to a resource representing the person to whom the Vision products will be supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
}
]
},
{
"path": "VisionPrescription.prescriber",
"short": "Who authorizes the Vision product",
"definition": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity": "rim",
"map": "author.role"
}
]
},
{
"path": "VisionPrescription.encounter",
"short": "Created during encounter / admission / stay",
"definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"path": "VisionPrescription.reason[x]",
"short": "Reason or indication for writing the prescription",
"definition": "Can be the reason or the indication for writing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation\nor\nreason.observation[code=ASSERTION].value"
}
]
},
{
"path": "VisionPrescription.dispense",
"short": "Vision supply authorization",
"definition": "Deals with details of the dispense part of the supply specification.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"path": "VisionPrescription.dispense.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "VisionPrescription.dispense.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. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "VisionPrescription.dispense.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 that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"comments": "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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "VisionPrescription.dispense.product",
"short": "Product to be supplied",
"definition": "Identifies the type of Vision correction product which is required for the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "VisionProduct",
"strength": "example",
"description": "A coded concept describing the Vision products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vision-product"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.role"
}
]
},
{
"path": "VisionPrescription.dispense.eye",
"short": "right | left",
"definition": "The eye for which the lens applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "VisionEyes",
"strength": "required",
"description": "A coded concept listing the eye codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/eye-codes"
}
}
},
{
"path": "VisionPrescription.dispense.sphere",
"short": "Lens sphere",
"definition": "Lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.cylinder",
"short": "Lens cylinder",
"definition": "Power adjustment for astigmatism measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.axis",
"short": "Lens axis",
"definition": "Adjustment for astigmatism measured in integer degrees.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "VisionPrescription.dispense.prism",
"short": "Lens prism",
"definition": "Amount of prism to compensate for eye alignment in fractional units.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.base",
"short": "up | down | in | out",
"definition": "The relative base, or reference lens edge, for the prism.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "VisionBase",
"strength": "required",
"description": "A coded concept listing the base codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/base-codes"
}
}
},
{
"path": "VisionPrescription.dispense.add",
"short": "Lens add",
"definition": "Power adjustment for multifocal lenses measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.power",
"short": "Contact Lens power",
"definition": "Contact lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.backCurve",
"short": "Contact lens back curvature",
"definition": "Back Curvature measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.diameter",
"short": "Contact Lens diameter",
"definition": "Contact lens diameter measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.duration",
"short": "Lens wear duration",
"definition": "The recommended maximum wear period for the lens.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "VisionPrescription.dispense.color",
"short": "Lens add",
"definition": "Special color or pattern.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "VisionPrescription.dispense.brand",
"short": "Lens add",
"definition": "Brand recommendations or restrictions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "VisionPrescription.dispense.notes",
"short": "Notes for coatings",
"definition": "Notes for special requirements such as coatings and lens materials.",
"alias": [
"0..1"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"path": "VisionPrescription",
"short": "Prescription for Vision correction products for a patient",
"definition": "An authorization for the supply of glasses and/or contact lenses to a patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "CombinedVisionRequest"
}
]
},
{
"path": "VisionPrescription.identifier",
"short": "Business identifier",
"definition": "Business identifier which may be used by other parties to reference or identify the prescription.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "VisionPrescription.dateWritten",
"short": "When prescription was authorized",
"definition": "The date (and perhaps time) when the prescription was written.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
},
{
"identity": "rim",
"map": "author.time"
}
]
},
{
"path": "VisionPrescription.patient",
"short": "Who prescription is for",
"definition": "A link to a resource representing the person to whom the Vision products will be supplied.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": "subject.role"
}
]
},
{
"path": "VisionPrescription.prescriber",
"short": "Who authorizes the Vision product",
"definition": "The healthcare professional responsible for authorizing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)"
},
{
"identity": "rim",
"map": "author.role"
}
]
},
{
"path": "VisionPrescription.encounter",
"short": "Created during encounter / admission / stay",
"definition": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": "componentOf.patientEncounter"
}
]
},
{
"path": "VisionPrescription.reason[x]",
"short": "Reason or indication for writing the prescription",
"definition": "Can be the reason or the indication for writing the prescription.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-16-Order Control Code Reason"
},
{
"identity": "rim",
"map": "reason.observation\nor\nreason.observation[code=ASSERTION].value"
}
]
},
{
"path": "VisionPrescription.dispense",
"short": "Vision supply authorization",
"definition": "Deals with details of the dispense part of the supply specification.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "component.supplyEvent"
}
]
},
{
"path": "VisionPrescription.dispense.product",
"short": "Product to be supplied",
"definition": "Identifies the type of Vision correction product which is required for the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"name": "VisionProduct",
"strength": "example",
"description": "A coded concept describing the Vision products.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/vision-product"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": "consumable.role"
}
]
},
{
"path": "VisionPrescription.dispense.eye",
"short": "right | left",
"definition": "The eye for which the lens applies.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "VisionEyes",
"strength": "required",
"description": "A coded concept listing the eye codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/eye-codes"
}
}
},
{
"path": "VisionPrescription.dispense.sphere",
"short": "Lens sphere",
"definition": "Lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.cylinder",
"short": "Lens cylinder",
"definition": "Power adjustment for astigmatism measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.axis",
"short": "Lens axis",
"definition": "Adjustment for astigmatism measured in integer degrees.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"path": "VisionPrescription.dispense.prism",
"short": "Lens prism",
"definition": "Amount of prism to compensate for eye alignment in fractional units.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.base",
"short": "up | down | in | out",
"definition": "The relative base, or reference lens edge, for the prism.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "VisionBase",
"strength": "required",
"description": "A coded concept listing the base codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/base-codes"
}
}
},
{
"path": "VisionPrescription.dispense.add",
"short": "Lens add",
"definition": "Power adjustment for multifocal lenses measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.power",
"short": "Contact Lens power",
"definition": "Contact lens power measured in diopters (0.25 units).",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.backCurve",
"short": "Contact lens back curvature",
"definition": "Back Curvature measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.diameter",
"short": "Contact Lens diameter",
"definition": "Contact lens diameter measured in millimeters.",
"min": 0,
"max": "1",
"type": [
{
"code": "decimal"
}
]
},
{
"path": "VisionPrescription.dispense.duration",
"short": "Lens wear duration",
"definition": "The recommended maximum wear period for the lens.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"path": "VisionPrescription.dispense.color",
"short": "Lens add",
"definition": "Special color or pattern.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "VisionPrescription.dispense.brand",
"short": "Lens add",
"definition": "Brand recommendations or restrictions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "VisionPrescription.dispense.notes",
"short": "Notes for coatings",
"definition": "Notes for special requirements such as coatings and lens materials.",
"alias": [
"0..1"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
}
]
}
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 DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:23+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change