This page is part of the FHIR Specification (v0.11: DSTU 1 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Base Resources defined as profiles (implementation assistance, for for validation, derivation and product development)
{
"feed":{
"title":"Resources as Profiles",
"id":"http://hl7.org/fhir/profile/resources",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/profiles-resources.xml"
}
],
"updated":"2014-01-31T20:45:47.577+11:00",
"entry":[
{
"title":"\"valueset\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/valueset",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/valueset.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A value set specifies a set of codes drawn from one or more code systems.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet\"><b>ValueSet<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The identifier that is 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.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name describing the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Informal name for this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of the individual or organization that published the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Human language description of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A copyright statement relating to the value set and/or its contents.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.copyright\"><b>copyright<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">About the value set or its content<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the value set (this element modifies the meaning of other elements)\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date that the value set status was last changed.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When value set defines its own codes.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define\"><b>define<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set defines its own codes --><\/span>\r\n <<a title=\"URI to identify the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">URI to identify the code system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If code comparison is case sensitive when codes within this systemare compared to each other.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.caseSensitive\"><b>caseSensitive<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If code comparison is case sensitive<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Concepts in the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept\"><b>concept<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Concepts in the code system --><\/span>\r\n <<a title=\"Code that identifies concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Code that identifies concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If this code is not for use as a real concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.abstract\"><b>abstract<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this code is not for use as a real concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Text to Display to the user.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text to Display to the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal Definition.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.definition\"><b>definition<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Formal Definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Child Concepts (is-a / contains).\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.concept\"><b>concept<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.define.concept<\/span> <span style=\"color: navy\">Child Concepts (is-a / contains)<\/span><span style=\"color: Gray\"> --><\/span></concept>\r\n </concept>\r\n </define>\r\n <<a title=\"When value set includes codes from elsewhere.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose\"><b>compose<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set includes codes from elsewhere --><\/span>\r\n <<a title=\"Includes the contents of the referenced value set as part of the contents of this value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.import\"><b>import<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A value set composition must have an include or an import\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Import the contents of another value set<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Include one or more codes from a code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include\"><b>include<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A value set composition must have an include or an import\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Include one or more codes from a code system --><\/span>\r\n <<a title=\"The code system from which the selected codes come from.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The system the codes come from<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the code system that the codes are selected from.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Specific version of the code system referred to<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies a code or concept to be included or excluded.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Code or concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they must all be true.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter\"><b>filter<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Select codes/concepts by their properties (including relationships) --><\/span>\r\n <<a title=\"A code that identifies a property defined in the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.property\"><b>property<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">A property defined by the code system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of operation to perform as part of the filter criteria.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.op\"><b>op<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"filter-operator.htm\">= | is-a | is_not_a | regex<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Code from the system, or regex criteria<\/span><span style=\"color: Gray\"> --><\/span>\r\n </filter>\r\n </include>\r\n <<a title=\"Exclude one or more codes from the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.exclude\"><b>exclude<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A value set with only one import must also have an include and/or an exclude unless the value set defines its own codes\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.compose.include<\/span> <span style=\"color: navy\">Explicitly exclude codes<\/span><span style=\"color: Gray\"> --><\/span></exclude>\r\n </compose>\r\n <<a title=\"When value set is an expansion.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion\"><b>expansion<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set is an expansion --><\/span>\r\n <<a title=\"Time valueset expansion happened.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.timestamp\"><b>timestamp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time valueset expansion happened<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes in the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains\"><b>contains<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Codes in the value set --><\/span>\r\n <<a title=\"System value for the code.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">System value for the code<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code - if blank, this is not a choosable code.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Must have a code or a display\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Code - if blank, this is not a choosable code<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"User display for the concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Must have a code or a display\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">User display for the concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes contained in this concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.contains\"><b>contains<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.expansion.contains<\/span> <span style=\"color: navy\">Codes contained in this concept<\/span><span style=\"color: Gray\"> --><\/span></contains>\r\n </contains>\r\n </expansion>\r\n</ValueSet>\r\n<\/pre><\/div>"
},
"name":{
"value":"valueset"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A value set specifies a set of codes drawn from one or more code systems."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"ValueSet"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"ValueSet"
},
"definition":{
"short":{
"value":"A set of codes drawn from one or more code systems"
},
"formal":{
"value":"A value set specifies a set of codes drawn from one or more code systems."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"severity":{
"value":"error"
},
"human":{
"value":"A value set with only one import must also have an include and/or an exclude unless the value set defines its own codes"
},
"xpath":{
"value":"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))"
}
},
{
"key":{
"value":"7"
},
"severity":{
"value":"error"
},
"human":{
"value":"A defined code system (if present) must have a different identifier to the value set itself"
},
"xpath":{
"value":"not(exists(f:define)) or (f:define/f:system/@value != f:identifier/@value)"
}
},
{
"key":{
"value":"5"
},
"severity":{
"value":"error"
},
"human":{
"value":"Value set must contain either a define, a compose, or an expansion element"
},
"xpath":{
"value":"exists(f:define) or exists(f:compose) or exists(f:expansion)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.identifier"
},
"definition":{
"short":{
"value":"Logical id to reference this value set"
},
"formal":{
"value":"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.version"
},
"definition":{
"short":{
"value":"Logical id for this version of the value set"
},
"formal":{
"value":"The identifier that is 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":{
"value":"There may be multiple resource versions of the value set that have this same identifier."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.name"
},
"definition":{
"short":{
"value":"Informal name for this value set"
},
"formal":{
"value":"A free text natural language name describing the value set."
},
"comments":{
"value":"Not expected to be unique."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.publisher"
},
"definition":{
"short":{
"value":"Name of the publisher (Organization or individual)"
},
"formal":{
"value":"The name of the individual or organization that published the value set."
},
"comments":{
"value":"Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.telecom"
},
"definition":{
"short":{
"value":"Contact information of the publisher"
},
"formal":{
"value":"Contacts of the publisher to assist a user in finding and communicating with the publisher."
},
"comments":{
"value":"May be a web site, an email address, a telephone number (tel:), etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.description"
},
"definition":{
"short":{
"value":"Human language description of the value set"
},
"formal":{
"value":"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.copyright"
},
"definition":{
"short":{
"value":"About the value set or its content"
},
"formal":{
"value":"A copyright statement relating to the value set and/or its contents."
},
"comments":{
"value":"Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.status"
},
"definition":{
"short":{
"value":"draft | experimental | review | production | withdrawn | superseded"
},
"formal":{
"value":"The status of the value set."
},
"comments":{
"value":"Allows filtering of valuesets that are appropriate for use vs. not."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ValueSetStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.experimental"
},
"definition":{
"short":{
"value":"If for testing purposes, not real usage"
},
"formal":{
"value":"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."
},
"comments":{
"value":"Allows filtering of valuesets that are appropriate for use vs. not."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.date"
},
"definition":{
"short":{
"value":"Date for given status"
},
"formal":{
"value":"The date that the value set status was last changed."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.define"
},
"definition":{
"short":{
"value":"When value set defines its own codes"
},
"formal":{
"value":"When value set defines its own codes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.system"
},
"definition":{
"short":{
"value":"URI to identify the code system"
},
"formal":{
"value":"URI to identify the code system."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.caseSensitive"
},
"definition":{
"short":{
"value":"If code comparison is case sensitive"
},
"formal":{
"value":"If code comparison is case sensitive when codes within this systemare compared to each other."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.concept"
},
"definition":{
"short":{
"value":"Concepts in the code system"
},
"formal":{
"value":"Concepts in the code system."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.concept.code"
},
"definition":{
"short":{
"value":"Code that identifies concept"
},
"formal":{
"value":"Code that identifies concept."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
}
}
},
{
"path":{
"value":"ValueSet.define.concept.abstract"
},
"definition":{
"short":{
"value":"If this code is not for use as a real concept"
},
"formal":{
"value":"If this code is not for use as a real concept."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.concept.display"
},
"definition":{
"short":{
"value":"Text to Display to the user"
},
"formal":{
"value":"Text to Display to the user."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.concept.definition"
},
"definition":{
"short":{
"value":"Formal Definition"
},
"formal":{
"value":"Formal Definition."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.define.concept.concept"
},
"definition":{
"short":{
"value":"Child Concepts (is-a / contains)"
},
"formal":{
"value":"Child Concepts (is-a / contains)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@ValueSet.define.concept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.compose"
},
"definition":{
"short":{
"value":"When value set includes codes from elsewhere"
},
"formal":{
"value":"When value set includes codes from elsewhere."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"severity":{
"value":"error"
},
"human":{
"value":"A value set composition must have an include or an import"
},
"xpath":{
"value":"exists(f:include) or exists(f:import)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.compose.import"
},
"definition":{
"short":{
"value":"Import the contents of another value set"
},
"formal":{
"value":"Includes the contents of the referenced value set as part of the contents of this value set."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include"
},
"definition":{
"short":{
"value":"Include one or more codes from a code system"
},
"formal":{
"value":"Include one or more codes from a code system."
},
"comments":{
"value":"If there are no codes or filters, the entire code system is included."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.system"
},
"definition":{
"short":{
"value":"The system the codes come from"
},
"formal":{
"value":"The code system from which the selected codes come from."
},
"comments":{
"value":"See [[Coding.system]] for further documentation."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.version"
},
"definition":{
"short":{
"value":"Specific version of the code system referred to"
},
"formal":{
"value":"The version of the code system that the codes are selected from."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.code"
},
"definition":{
"short":{
"value":"Code or concept"
},
"formal":{
"value":"Specifies a code or concept to be included or excluded."
},
"comments":{
"value":"expressions are allowed if defined by the underlying code system."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.filter"
},
"definition":{
"short":{
"value":"Select codes/concepts by their properties (including relationships)"
},
"formal":{
"value":"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they must all be true."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.filter.property"
},
"definition":{
"short":{
"value":"A property defined by the code system"
},
"formal":{
"value":"A code that identifies a property defined in the code system."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.filter.op"
},
"definition":{
"short":{
"value":"= | is-a | is_not_a | regex"
},
"formal":{
"value":"The kind of operation to perform as part of the filter criteria."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"FilterOperator"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.include.filter.value"
},
"definition":{
"short":{
"value":"Code from the system, or regex criteria"
},
"formal":{
"value":"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":{
"value":"Use regex matching with care - full regex matching on every SNOMED-CT term is prohibitive, for example."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.compose.exclude"
},
"definition":{
"short":{
"value":"Explicitly exclude codes"
},
"formal":{
"value":"Exclude one or more codes from the value set."
},
"comments":{
"value":"usually this is used to selectively exclude codes that were included by subsumption in the inclusions."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@ValueSet.compose.include"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"ValueSet.expansion"
},
"definition":{
"short":{
"value":"When value set is an expansion"
},
"formal":{
"value":"When value set is an expansion."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.expansion.timestamp"
},
"definition":{
"short":{
"value":"Time valueset expansion happened"
},
"formal":{
"value":"Time valueset expansion happened."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.expansion.contains"
},
"definition":{
"short":{
"value":"Codes in the value set"
},
"formal":{
"value":"Codes in the value set."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"6"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must have a code or a display"
},
"xpath":{
"value":"exists(f:code) or exists(f:display)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.expansion.contains.system"
},
"definition":{
"short":{
"value":"System value for the code"
},
"formal":{
"value":"System value for the code."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.expansion.contains.code"
},
"definition":{
"short":{
"value":"Code - if blank, this is not a choosable code"
},
"formal":{
"value":"Code - if blank, this is not a choosable code."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
}
}
},
{
"path":{
"value":"ValueSet.expansion.contains.display"
},
"definition":{
"short":{
"value":"User display for the concept"
},
"formal":{
"value":"User display for the concept."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ValueSet.expansion.contains.contains"
},
"definition":{
"short":{
"value":"Codes contained in this concept"
},
"formal":{
"value":"Codes contained in this concept."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@ValueSet.expansion.contains"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"ValueSetStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/valueset-status"
}
}
},
{
"name":{
"value":"FilterOperator"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/filter-operator"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A value set specifies a set of codes drawn from one or more code systems.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet\"><b>ValueSet<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The identifier that is 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.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name describing the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Informal name for this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of the individual or organization that published the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Human language description of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A copyright statement relating to the value set and/or its contents.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.copyright\"><b>copyright<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">About the value set or its content<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the value set (this element modifies the meaning of other elements)\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date that the value set status was last changed.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When value set defines its own codes.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define\"><b>define<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set defines its own codes --><\/span>\r\n <<a title=\"URI to identify the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">URI to identify the code system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If code comparison is case sensitive when codes within this systemare compared to each other.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.caseSensitive\"><b>caseSensitive<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If code comparison is case sensitive<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Concepts in the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept\"><b>concept<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Concepts in the code system --><\/span>\r\n <<a title=\"Code that identifies concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Code that identifies concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If this code is not for use as a real concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.abstract\"><b>abstract<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this code is not for use as a real concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Text to Display to the user.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text to Display to the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal Definition.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.definition\"><b>definition<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Formal Definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Child Concepts (is-a / contains).\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.define.concept.concept\"><b>concept<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.define.concept<\/span> <span style=\"color: navy\">Child Concepts (is-a / contains)<\/span><span style=\"color: Gray\"> --><\/span></concept>\r\n </concept>\r\n </define>\r\n <<a title=\"When value set includes codes from elsewhere.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose\"><b>compose<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set includes codes from elsewhere --><\/span>\r\n <<a title=\"Includes the contents of the referenced value set as part of the contents of this value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.import\"><b>import<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A value set composition must have an include or an import\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Import the contents of another value set<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Include one or more codes from a code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include\"><b>include<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A value set composition must have an include or an import\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Include one or more codes from a code system --><\/span>\r\n <<a title=\"The code system from which the selected codes come from.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The system the codes come from<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the code system that the codes are selected from.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Specific version of the code system referred to<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies a code or concept to be included or excluded.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Code or concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they must all be true.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter\"><b>filter<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Select codes/concepts by their properties (including relationships) --><\/span>\r\n <<a title=\"A code that identifies a property defined in the code system.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.property\"><b>property<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">A property defined by the code system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of operation to perform as part of the filter criteria.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.op\"><b>op<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"filter-operator.htm\">= | is-a | is_not_a | regex<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.include.filter.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Code from the system, or regex criteria<\/span><span style=\"color: Gray\"> --><\/span>\r\n </filter>\r\n </include>\r\n <<a title=\"Exclude one or more codes from the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.compose.exclude\"><b>exclude<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A value set with only one import must also have an include and/or an exclude unless the value set defines its own codes\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.compose.include<\/span> <span style=\"color: navy\">Explicitly exclude codes<\/span><span style=\"color: Gray\"> --><\/span></exclude>\r\n </compose>\r\n <<a title=\"When value set is an expansion.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion\"><b>expansion<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set must contain either a define, a compose, or an expansion element\" style=\"color: deeppink\"><b>0..1<\/b><\/span> When value set is an expansion --><\/span>\r\n <<a title=\"Time valueset expansion happened.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.timestamp\"><b>timestamp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time valueset expansion happened<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes in the value set.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains\"><b>contains<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Codes in the value set --><\/span>\r\n <<a title=\"System value for the code.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">System value for the code<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code - if blank, this is not a choosable code.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Must have a code or a display\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Code - if blank, this is not a choosable code<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"User display for the concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Must have a code or a display\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">User display for the concept<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes contained in this concept.\" class=\"dict\" href=\"valueset-definitions.htm#ValueSet.expansion.contains.contains\"><b>contains<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for ValueSet.expansion.contains<\/span> <span style=\"color: navy\">Codes contained in this concept<\/span><span style=\"color: Gray\"> --><\/span></contains>\r\n </contains>\r\n </expansion>\r\n</ValueSet>\r\n<\/pre><\/div>"
},
{
"title":"\"conformance-base\" - to help with system development",
"id":"http://hl7.org/fhir/conformance/conformance-base",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/conformance/conformance-base"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Conformance":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><h2>Base FHIR Conformance Statement<\/h2><p>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<\/p><table><tr><td>Mode<\/td><td>server<\/td><\/tr><tr><td>Description<\/td><td>All the functionality defined in FHIR<\/td><\/tr><tr><td>Batch<\/td><td>y<\/td><\/tr><tr><td>System History<\/td><td>y<\/td><\/tr><\/table><table><tr><th><b>Resource Type<\/b><\/th><th><b>Profile<\/b><\/th><th><b>Read<\/b><\/th><th><b>V-Read<\/b><\/th><th><b>Search<\/b><\/th><th><b>Update<\/b><\/th><th><b>Updates<\/b><\/th><th><b>Create<\/b><\/th><th><b>Delete<\/b><\/th><th><b>History<\/b><\/th><\/tr><tr><td>AdverseReaction<\/td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Alert<\/td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>AllergyIntolerance<\/td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>CarePlan<\/td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Condition<\/td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Conformance<\/td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Coverage<\/td><td><a href=\"http://hl7.org/fhir/Coverage\">http://hl7.org/fhir/Coverage<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Device<\/td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceCapabilities<\/td><td><a href=\"http://hl7.org/fhir/DeviceCapabilities\">http://hl7.org/fhir/DeviceCapabilities<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceLog<\/td><td><a href=\"http://hl7.org/fhir/DeviceLog\">http://hl7.org/fhir/DeviceLog<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceObservation<\/td><td><a href=\"http://hl7.org/fhir/DeviceObservation\">http://hl7.org/fhir/DeviceObservation<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DiagnosticOrder<\/td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DiagnosticReport<\/td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Document<\/td><td><a href=\"http://hl7.org/fhir/Document\">http://hl7.org/fhir/Document<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DocumentReference<\/td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Encounter<\/td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>FamilyHistory<\/td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Group<\/td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ImagingStudy<\/td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Immunization<\/td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ImmunizationProfile<\/td><td><a href=\"http://hl7.org/fhir/ImmunizationProfile\">http://hl7.org/fhir/ImmunizationProfile<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>List<\/td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Location<\/td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Media<\/td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Medication<\/td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationAdministration<\/td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationDispense<\/td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationPrescription<\/td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationStatement<\/td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Message<\/td><td><a href=\"http://hl7.org/fhir/Message\">http://hl7.org/fhir/Message<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Observation<\/td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>OperationOutcome<\/td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Order<\/td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>OrderResponse<\/td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Organization<\/td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Other<\/td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Patient<\/td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Practitioner<\/td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Procedure<\/td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Profile<\/td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Provenance<\/td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Query<\/td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Questionnaire<\/td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>RelatedPerson<\/td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>SecurityEvent<\/td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Specimen<\/td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Substance<\/td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Supply<\/td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ValueSet<\/td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><\/table><\/div>"
},
"identifier":{
"value":"http://hl7.org/fhir/conformance/base"
},
"version":{
"value":"0.11-????"
},
"name":{
"value":"Base FHIR Conformance Statement"
},
"publisher":{
"value":"FHIR Project Team"
},
"telecom":[
{
"system":{
"value":"url"
},
"value":{
"value":"http://hl7.org/fhir"
}
}
],
"description":{
"value":"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":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"fhirVersion":{
"value":"0.11"
},
"acceptUnknown":{
"value":false
},
"format":[
{
"value":"xml"
},
{
"value":"json"
}
],
"rest":[
{
"mode":{
"value":"server"
},
"documentation":{
"value":"All the functionality defined in FHIR"
},
"resource":[
{
"type":{
"value":"AdverseReaction"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/AdverseReaction"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"substance"
},
"source":{
"value":"http://hl7.org/fhir/AdverseReaction/search#substance"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The name or code of the substance that produces the sensitivity"
},
"xpath":{
"value":"f:AdverseReaction/f:exposure/f:substance"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/AdverseReaction/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/AdverseReaction/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject that the sensitivity is about"
},
"xpath":{
"value":"f:AdverseReaction/f:subject"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/AdverseReaction/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the date of the reaction"
},
"xpath":{
"value":"f:AdverseReaction/f:reactionDate"
}
},
{
"name":{
"value":"symptom"
},
"source":{
"value":"http://hl7.org/fhir/AdverseReaction/search#symptom"
},
"type":{
"value":"token"
},
"documentation":{
"value":"One of the symptoms of the reaction."
},
"xpath":{
"value":"f:AdverseReaction/f:symptom/f:code"
}
}
]
},
{
"type":{
"value":"Alert"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Alert"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Alert/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Alert/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a subject to list alerts for"
},
"xpath":{
"value":"f:Alert/f:subject"
}
}
]
},
{
"type":{
"value":"AllergyIntolerance"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/AllergyIntolerance"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"substance"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#substance"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The name or code of the substance that produces the sensitivity"
},
"xpath":{
"value":"f:AllergyIntolerance/f:substance"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The status of the sensitivity"
},
"xpath":{
"value":"f:AllergyIntolerance/f:status"
}
},
{
"name":{
"value":"recorder"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#recorder"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"who recorded the sensitivity"
},
"xpath":{
"value":"f:AllergyIntolerance/f:recorder"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject that the sensitivity is about"
},
"xpath":{
"value":"f:AllergyIntolerance/f:subject"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"recorded date/time."
},
"xpath":{
"value":"f:AllergyIntolerance/f:recordedDate"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/AllergyIntolerance/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The type of sensitivity"
},
"xpath":{
"value":"f:AllergyIntolerance/f:sensitivityType"
}
}
]
},
{
"type":{
"value":"CarePlan"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/CarePlan"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"[CarePlan.patient]"
},
"xpath":{
"value":"f:CarePlan/f:patient"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"condition"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#condition"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"[CarePlan.concern]"
},
"xpath":{
"value":"f:CarePlan/f:concern"
}
},
{
"name":{
"value":"activitydate"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#activitydate"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Specified date occurs within period specified by CarePlan.activity.timingSchedule"
}
},
{
"name":{
"value":"participant"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#participant"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"[CarePlan.participant.member]"
},
"xpath":{
"value":"f:CarePlan/f:participant/f:member"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"[CarePlan.period] contains date"
},
"xpath":{
"value":"f:CarePlan/f:period"
}
},
{
"name":{
"value":"activity"
},
"source":{
"value":"http://hl7.org/fhir/CarePlan/search#activity"
},
"type":{
"value":"token"
},
"documentation":{
"value":"[CarePlan.activity.code]"
},
"xpath":{
"value":"f:CarePlan/f:activity/f:code"
}
}
]
},
{
"type":{
"value":"Condition"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Condition"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"asserter"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#asserter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Person who asserts this condition"
},
"xpath":{
"value":"f:Condition/f:asserter"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the status of the condition"
},
"xpath":{
"value":"f:Condition/f:status"
}
},
{
"name":{
"value":"location"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#location"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Location - may include laterality"
},
"xpath":{
"value":"f:Condition/f:location/f:code"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Subject of this condition"
},
"xpath":{
"value":"f:Condition/f:subject"
}
},
{
"name":{
"value":"onset"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#onset"
},
"type":{
"value":"date"
},
"documentation":{
"value":"when the Condition started (if started on a date)"
},
"xpath":{
"value":"f:Condition/f:onset[x]"
}
},
{
"name":{
"value":"evidence"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#evidence"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Manifestation/symptom"
},
"xpath":{
"value":"f:Condition/f:evidence/f:code"
}
},
{
"name":{
"value":"severity"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#severity"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the severity of the condition"
},
"xpath":{
"value":"f:Condition/f:severity"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"code for the condition"
},
"xpath":{
"value":"f:Condition/f:code"
}
},
{
"name":{
"value":"encounter"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#encounter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Encounter during which the condition was first asserted"
},
"xpath":{
"value":"f:Condition/f:encounter"
}
},
{
"name":{
"value":"date-asserted"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#date-asserted"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When first detected/suspected/entered"
},
"xpath":{
"value":"f:Condition/f:dateAsserted"
}
},
{
"name":{
"value":"stage"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#stage"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Simple summary (disease specific)"
},
"xpath":{
"value":"f:Condition/f:stage/f:summary"
}
},
{
"name":{
"value":"related-code"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#related-code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Relationship target by means of a predefined code"
},
"xpath":{
"value":"f:Condition/f:relatedItem/f:code"
}
},
{
"name":{
"value":"category"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#category"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the category of the condition"
},
"xpath":{
"value":"f:Condition/f:category"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"related-item"
},
"source":{
"value":"http://hl7.org/fhir/Condition/search#related-item"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Relationship target resource"
},
"xpath":{
"value":"f:Condition/f:relatedItem/f:target"
}
}
]
},
{
"type":{
"value":"Conformance"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Conformance"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"software"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#software"
},
"type":{
"value":"string"
},
"documentation":{
"value":"part of a the name of a software application"
},
"xpath":{
"value":"f:Conformance/f:software/f:name"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"event"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#event"
},
"type":{
"value":"token"
},
"documentation":{
"value":"event code in a conformance statement"
},
"xpath":{
"value":"f:Conformance/f:messaging/f:event/f:code"
}
},
{
"name":{
"value":"resource"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#resource"
},
"type":{
"value":"token"
},
"documentation":{
"value":"name of a resource mentioned in a conformance statement"
},
"xpath":{
"value":"f:Conformance/f:rest/f:resource/f:type"
}
},
{
"name":{
"value":"security"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#security"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Information about security of implementation"
},
"xpath":{
"value":"f:Conformance/f:rest/f:security"
}
},
{
"name":{
"value":"format"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#format"
},
"type":{
"value":"token"
},
"documentation":{
"value":"formats supported (xml | json | mime type)"
},
"xpath":{
"value":"f:Conformance/f:format"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the conformance statement publication date"
},
"xpath":{
"value":"f:Conformance/f:date"
}
},
{
"name":{
"value":"profile"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#profile"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"a profile id invoked in a conformance statement"
},
"xpath":{
"value":"f:Conformance/f:rest/f:resource/f:profile"
}
},
{
"name":{
"value":"mode"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#mode"
},
"type":{
"value":"token"
},
"documentation":{
"value":"mode - restful (server/client) or messaging (sender/receiver)"
},
"xpath":{
"value":"f:Conformance/f:rest/f:mode"
}
},
{
"name":{
"value":"version"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#version"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the version of FHIR"
},
"xpath":{
"value":"f:Conformance/f:version"
}
},
{
"name":{
"value":"publisher"
},
"source":{
"value":"http://hl7.org/fhir/Conformance/search#publisher"
},
"type":{
"value":"string"
},
"documentation":{
"value":"part of a publisher name"
},
"xpath":{
"value":"f:Conformance/f:publisher"
}
}
]
},
{
"type":{
"value":"Coverage"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Coverage"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"plan"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#plan"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A plan or policy identifier"
},
"xpath":{
"value":"f:Coverage/f:plan"
}
},
{
"name":{
"value":"issuer"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#issuer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of the insurer"
},
"xpath":{
"value":"f:Coverage/f:issuer"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"sequence"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#sequence"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Sequence number"
},
"xpath":{
"value":"f:Coverage/f:sequence"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The name of the subscriber"
},
"xpath":{
"value":"f:Coverage/f:subscriber/f:name"
}
},
{
"name":{
"value":"dependent"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#dependent"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Dependent number"
},
"xpath":{
"value":"f:Coverage/f:dependent"
}
},
{
"name":{
"value":"group"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#group"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Group identifier"
},
"xpath":{
"value":"f:Coverage/f:group"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The kind of coverage"
},
"xpath":{
"value":"f:Coverage/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The primary identifier of the insured"
},
"xpath":{
"value":"f:Coverage/f:identifier"
}
},
{
"name":{
"value":"subplan"
},
"source":{
"value":"http://hl7.org/fhir/Coverage/search#subplan"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Sub-plan identifier"
},
"xpath":{
"value":"f:Coverage/f:subplan"
}
}
]
},
{
"type":{
"value":"Device"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Device"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"organization"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#organization"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the organization responsible for the device"
},
"xpath":{
"value":"f:Device/f:owner"
}
},
{
"name":{
"value":"model"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#model"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the model of the device"
},
"xpath":{
"value":"f:Device/f:model"
}
},
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"If the resource is affixed to a person"
},
"xpath":{
"value":"f:Device/f:patient"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"location"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#location"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Where the resource is found"
},
"xpath":{
"value":"f:Device/f:location"
}
},
{
"name":{
"value":"manufacturer"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#manufacturer"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the manufacturer of the device"
},
"xpath":{
"value":"f:Device/f:manufacturer"
}
},
{
"name":{
"value":"assigned-id"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#assigned-id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"identifier assigned by the organization"
},
"xpath":{
"value":"f:Device/f:assignedId"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the type of the device"
},
"xpath":{
"value":"f:Device/f:type"
}
},
{
"name":{
"value":"serial"
},
"source":{
"value":"http://hl7.org/fhir/Device/search#serial"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the serial number of the device"
},
"xpath":{
"value":"f:Device/f:identity/f:serialNumber"
}
}
]
},
{
"type":{
"value":"DeviceCapabilities"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DeviceCapabilities"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"identity"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#identity"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Identifies this particular device uniquely"
},
"xpath":{
"value":"f:DeviceCapabilities/f:identity"
}
},
{
"name":{
"value":"facet"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#facet"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The facet code"
},
"xpath":{
"value":"f:DeviceCapabilities/f:virtualDevice/f:channel/f:metric/f:facet/f:code"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"metric"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#metric"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The metric code"
},
"xpath":{
"value":"f:DeviceCapabilities/f:virtualDevice/f:channel/f:metric/f:code"
}
},
{
"name":{
"value":"manufacturer"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#manufacturer"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Company that built the device"
},
"xpath":{
"value":"f:DeviceCapabilities/f:manufacturer"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"The name of this device"
},
"xpath":{
"value":"f:DeviceCapabilities/f:name"
}
},
{
"name":{
"value":"datatype"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#datatype"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Quantity | Coding | Array | string"
},
"xpath":{
"value":"f:DeviceCapabilities/f:virtualDevice/f:channel/f:metric/f:info/f:type"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The compatment code"
},
"xpath":{
"value":"f:DeviceCapabilities/f:virtualDevice/f:code"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The type of device"
},
"xpath":{
"value":"f:DeviceCapabilities/f:type"
}
},
{
"name":{
"value":"channel"
},
"source":{
"value":"http://hl7.org/fhir/DeviceCapabilities/search#channel"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The channel code"
},
"xpath":{
"value":"f:DeviceCapabilities/f:virtualDevice/f:channel/f:code"
}
}
]
},
{
"type":{
"value":"DeviceLog"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DeviceLog"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"flag"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#flag"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Information about the quality of the data etc"
},
"xpath":{
"value":"f:DeviceLog/f:item/f:flag"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Subject of the measurement"
},
"xpath":{
"value":"f:DeviceLog/f:subject"
}
},
{
"name":{
"value":"value"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#value"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The value of the data item, if available"
},
"xpath":{
"value":"f:DeviceLog/f:item/f:value"
}
},
{
"name":{
"value":"capabilities"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#capabilities"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Explicit reference to the capabilities"
},
"xpath":{
"value":"f:DeviceLog/f:capabilities"
}
},
{
"name":{
"value":"instant"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#instant"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When the data values are reported"
},
"xpath":{
"value":"f:DeviceLog/f:instant"
}
},
{
"name":{
"value":"key"
},
"source":{
"value":"http://hl7.org/fhir/DeviceLog/search#key"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Reference to device capabilities declaration"
},
"xpath":{
"value":"f:DeviceLog/f:item/f:key"
}
}
]
},
{
"type":{
"value":"DeviceObservation"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DeviceObservation"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject of the measurements"
},
"xpath":{
"value":"f:DeviceObservation/f:subject"
}
},
{
"name":{
"value":"issued"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#issued"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Date the measurements were made"
},
"xpath":{
"value":"f:DeviceObservation/f:issued"
}
},
{
"name":{
"value":"device"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#device"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Device that produced the results"
},
"xpath":{
"value":"f:DeviceObservation/f:device"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Type of device observation"
},
"xpath":{
"value":"f:DeviceObservation/f:code"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identifiers assigned to this observation"
},
"xpath":{
"value":"f:DeviceObservation/f:identifier"
}
},
{
"name":{
"value":"measurement"
},
"source":{
"value":"http://hl7.org/fhir/DeviceObservation/search#measurement"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Actual measurements"
},
"xpath":{
"value":"f:DeviceObservation/f:measurement"
}
}
]
},
{
"type":{
"value":"DiagnosticOrder"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DiagnosticOrder"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"orderer"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#orderer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who ordered the test"
},
"xpath":{
"value":"f:DiagnosticOrder/f:orderer"
}
},
{
"name":{
"value":"past-status"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#past-status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"xpath":{
"value":"f:DiagnosticOrder/f:event/f:status"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"xpath":{
"value":"f:DiagnosticOrder/f:status"
}
},
{
"name":{
"value":"item-status"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#item-status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"xpath":{
"value":"f:DiagnosticOrder/f:item/f:status"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who/what test is about"
},
"xpath":{
"value":"f:DiagnosticOrder/f:subject"
}
},
{
"name":{
"value":"item-past-status"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#item-past-status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"xpath":{
"value":"f:DiagnosticOrder/f:item/f:event/f:status"
}
},
{
"name":{
"value":"encounter"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#encounter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The encounter that this diagnostic order is associated with"
},
"xpath":{
"value":"f:DiagnosticOrder/f:encounter"
}
},
{
"name":{
"value":"actor"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#actor"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who recorded or did this"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Code for this item"
},
"xpath":{
"value":"f:DiagnosticOrder/f:item/f:code"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The date at which the event happened"
},
"xpath":{
"value":"f:DiagnosticOrder/f:event/f:date"
}
},
{
"name":{
"value":"status-date"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#status-date"
},
"type":{
"value":"composite"
},
"documentation":{
"value":"A combination of past-status and date"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"bodysite"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#bodysite"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Location of requested test (if applicable)"
},
"xpath":{
"value":"f:DiagnosticOrder/f:item/f:bodySite"
}
},
{
"name":{
"value":"item-date"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#item-date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The date at which the event happened"
},
"xpath":{
"value":"f:DiagnosticOrder/f:item/f:event/f:date"
}
},
{
"name":{
"value":"specimen"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#specimen"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"If the whole order relates to specific specimens"
}
},
{
"name":{
"value":"item-status-date"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#item-status-date"
},
"type":{
"value":"composite"
},
"documentation":{
"value":"A combination of item-past-status and item-date"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticOrder/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identifiers assigned to this order"
},
"xpath":{
"value":"f:DiagnosticOrder/f:identifier"
}
}
]
},
{
"type":{
"value":"DiagnosticReport"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DiagnosticReport"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"result"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#result"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"link to an atomic result (observation resource)"
},
"xpath":{
"value":"f:DiagnosticReport/f:results/f:result"
}
},
{
"name":{
"value":"requester"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#requester"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"who made a request that lead to the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:requestDetail/f:requester"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The status of the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:status"
}
},
{
"name":{
"value":"test"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#test"
},
"type":{
"value":"token"
},
"documentation":{
"value":"a test requested that the report is in response to"
},
"xpath":{
"value":"f:DiagnosticReport/f:requestDetail/f:requestTest"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the subject of the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:subject"
}
},
{
"name":{
"value":"issued"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#issued"
},
"type":{
"value":"date"
},
"documentation":{
"value":"when the report was issued"
},
"xpath":{
"value":"f:DiagnosticReport/f:issued"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"a coded diagnosis on the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:codedDiagnosis"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the clinically relevant time of the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:diagnosticTime"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"specimen"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#specimen"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the specimen details"
},
"xpath":{
"value":"f:DiagnosticReport/f:results/f:specimen"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the name/code of the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:results/f:name"
}
},
{
"name":{
"value":"service"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#service"
},
"type":{
"value":"token"
},
"documentation":{
"value":"which diagnostic discipline/department created the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:serviceCategory"
}
},
{
"name":{
"value":"performer"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#performer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"who was the source of the report (organization)"
},
"xpath":{
"value":"f:DiagnosticReport/f:performer"
}
},
{
"name":{
"value":"group"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#group"
},
"type":{
"value":"token"
},
"documentation":{
"value":"name /code of a group in the report"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/DiagnosticReport/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"an identifier for the report"
},
"xpath":{
"value":"f:DiagnosticReport/f:reportId"
}
}
]
},
{
"type":{
"value":"Document"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Document"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"author"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#author"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"author of the document"
},
"xpath":{
"value":"f:Document/f:author"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"attester"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#attester"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"attester of the document"
},
"xpath":{
"value":"f:Document/f:attester/f:party"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"subject of the document"
},
"xpath":{
"value":"f:Document/f:subject"
}
},
{
"name":{
"value":"section-content"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#section-content"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"content resource of the section"
},
"xpath":{
"value":"f:Document/f:section/f:content"
}
},
{
"name":{
"value":"context"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#context"
},
"type":{
"value":"token"
},
"documentation":{
"value":"context of the document"
},
"xpath":{
"value":"f:Document/f:event/f:code"
}
},
{
"name":{
"value":"section-type"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#section-type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"code of the document"
},
"xpath":{
"value":"f:Document/f:section/f:code"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the document creation time"
},
"xpath":{
"value":"f:Document/f:created"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the type of the document"
},
"xpath":{
"value":"f:Document/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Logical identifier for document (version-independent)"
},
"xpath":{
"value":"f:Document/f:identifier"
}
},
{
"name":{
"value":"version"
},
"source":{
"value":"http://hl7.org/fhir/Document/search#version"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Version-specific identifier for document"
},
"xpath":{
"value":"f:Document/f:versionIdentifier"
}
}
]
},
{
"type":{
"value":"DocumentReference"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/DocumentReference"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"supersedes"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#supersedes"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"If this document replaces another"
},
"xpath":{
"value":"f:DocumentReference/f:supercedes"
}
},
{
"name":{
"value":"location"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#location"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Where to access the document"
},
"xpath":{
"value":"f:DocumentReference/f:location"
}
},
{
"name":{
"value":"indexed"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#indexed"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When this document reference created"
},
"xpath":{
"value":"f:DocumentReference/f:indexed"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"current | superseded | error"
},
"xpath":{
"value":"f:DocumentReference/f:status"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject of the document"
},
"xpath":{
"value":"f:DocumentReference/f:subject"
}
},
{
"name":{
"value":"format"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#format"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Format of the document"
},
"xpath":{
"value":"f:DocumentReference/f:format"
}
},
{
"name":{
"value":"period"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#period"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Time described by the document"
},
"xpath":{
"value":"f:DocumentReference/f:context/f:period"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"What kind of document this is (LOINC if possible)"
},
"xpath":{
"value":"f:DocumentReference/f:type"
}
},
{
"name":{
"value":"authenticator"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#authenticator"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who authenticated the document"
},
"xpath":{
"value":"f:DocumentReference/f:authenticator"
}
},
{
"name":{
"value":"size"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#size"
},
"type":{
"value":"integer"
},
"documentation":{
"value":"Size of the document in bytes"
},
"xpath":{
"value":"f:DocumentReference/f:size"
}
},
{
"name":{
"value":"author"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#author"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who/what authored the document"
},
"xpath":{
"value":"f:DocumentReference/f:author"
}
},
{
"name":{
"value":"custodian"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#custodian"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Org which maintains the document"
},
"xpath":{
"value":"f:DocumentReference/f:custodian"
}
},
{
"name":{
"value":"facility"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#facility"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Kind of facility where patient was seen"
},
"xpath":{
"value":"f:DocumentReference/f:context/f:facilityType"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"created"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#created"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Document creation time"
},
"xpath":{
"value":"f:DocumentReference/f:created"
}
},
{
"name":{
"value":"event"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#event"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Type of context (i.e. type of event)"
},
"xpath":{
"value":"f:DocumentReference/f:context/f:code"
}
},
{
"name":{
"value":"confidentiality"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#confidentiality"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Sensitivity of source document"
},
"xpath":{
"value":"f:DocumentReference/f:confidentiality"
}
},
{
"name":{
"value":"description"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#description"
},
"type":{
"value":"text"
},
"documentation":{
"value":"Human Readable description (title)"
},
"xpath":{
"value":"f:DocumentReference/f:description"
}
},
{
"name":{
"value":"subtype"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#subtype"
},
"type":{
"value":"token"
},
"documentation":{
"value":"More detail about the document type"
},
"xpath":{
"value":"f:DocumentReference/f:subtype"
}
},
{
"name":{
"value":"language"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#language"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Primary language of the document"
},
"xpath":{
"value":"f:DocumentReference/f:primaryLanguage"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/DocumentReference/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Other identifiers for the document"
},
"xpath":{
"value":"f:DocumentReference/f:identifier"
}
}
]
},
{
"type":{
"value":"Encounter"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Encounter"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"start"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#start"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The date and time the encounter starts"
},
"xpath":{
"value":"f:Encounter/f:start"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"E.g. active, aborted, finished"
},
"xpath":{
"value":"f:Encounter/f:status"
}
},
{
"name":{
"value":"fulfills"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#fulfills"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The appointment that scheduled this encounter"
},
"xpath":{
"value":"f:Encounter/f:fulfills"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The patient present at the encounter"
},
"xpath":{
"value":"f:Encounter/f:subject"
}
},
{
"name":{
"value":"indication"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#indication"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Reason the encounter takes place"
},
"xpath":{
"value":"f:Encounter/f:indication"
}
},
{
"name":{
"value":"length"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#length"
},
"type":{
"value":"integer"
},
"documentation":{
"value":"Length of encounter in days"
},
"xpath":{
"value":"f:Encounter/f:length"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Encounter/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identifier(s) by which this encounter is known"
},
"xpath":{
"value":"f:Encounter/f:identifier"
}
}
]
},
{
"type":{
"value":"FamilyHistory"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/FamilyHistory"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/FamilyHistory/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/FamilyHistory/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a subject to list family history items for"
},
"xpath":{
"value":"f:FamilyHistory/f:subject"
}
}
]
},
{
"type":{
"value":"Group"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Group"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"member"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#member"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who is in group"
},
"xpath":{
"value":"f:Group/f:member"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"group-type"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#group-type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The type of resources the group contains"
},
"xpath":{
"value":"f:Group/f:type"
}
},
{
"name":{
"value":"type-value"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#type-value"
},
"type":{
"value":"composite"
},
"documentation":{
"value":"A composite of both type and value"
}
},
{
"name":{
"value":"value"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#value"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Value held by characteristic"
},
"xpath":{
"value":"f:Group/f:characteristic/f:value[x]"
}
},
{
"name":{
"value":"actual"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#actual"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Descriptive or actual"
},
"xpath":{
"value":"f:Group/f:actual"
}
},
{
"name":{
"value":"exclude"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#exclude"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Group includes or excludes"
},
"xpath":{
"value":"f:Group/f:characteristic/f:exclude"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The kind of resources contained"
},
"xpath":{
"value":"f:Group/f:code"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Kind of characteristic"
},
"xpath":{
"value":"f:Group/f:characteristic/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Group/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Unique id"
},
"xpath":{
"value":"f:Group/f:identifier"
}
}
]
},
{
"type":{
"value":"ImagingStudy"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/ImagingStudy"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"uid"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#uid"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Formal identifier for this instance (0008,0018)"
},
"xpath":{
"value":"f:ImagingStudy/f:series/f:instance/f:uid"
}
},
{
"name":{
"value":"series"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#series"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the series id for the image"
},
"xpath":{
"value":"f:ImagingStudy/f:series/f:uid"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"bodysite"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#bodysite"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Body part examined (Map from 0018,0015)"
},
"xpath":{
"value":"f:ImagingStudy/f:series/f:bodySite"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who the study is about"
},
"xpath":{
"value":"f:ImagingStudy/f:subject"
}
},
{
"name":{
"value":"accession"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#accession"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the accession id for the image"
},
"xpath":{
"value":"f:ImagingStudy/f:accessionNo"
}
},
{
"name":{
"value":"study"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#study"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the study id for the image"
},
"xpath":{
"value":"f:ImagingStudy/f:uid"
}
},
{
"name":{
"value":"modality"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#modality"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the modality of the image"
},
"xpath":{
"value":"f:ImagingStudy/f:series/f:modality"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the date the study was done was taken"
},
"xpath":{
"value":"f:ImagingStudy/f:dateTime"
}
},
{
"name":{
"value":"dicom-class"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#dicom-class"
},
"type":{
"value":"token"
},
"documentation":{
"value":"DICOM class type (0008,0016)"
},
"xpath":{
"value":"f:ImagingStudy/f:series/f:instance/f:sopclass"
}
},
{
"name":{
"value":"size"
},
"source":{
"value":"http://hl7.org/fhir/ImagingStudy/search#size"
},
"type":{
"value":"integer"
},
"documentation":{
"value":"the size of the image in MB - may include > or < in the value"
}
}
]
},
{
"type":{
"value":"Immunization"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Immunization"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"requester"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#requester"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The practitioner who ordered the vaccination"
},
"xpath":{
"value":"f:Immunization/f:requester"
}
},
{
"name":{
"value":"lot-number"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#lot-number"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Vaccine Lot Number"
},
"xpath":{
"value":"f:Immunization/f:lotNumber"
}
},
{
"name":{
"value":"vaccine-type"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#vaccine-type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Vaccine Product Type Administered"
},
"xpath":{
"value":"f:Immunization/f:vaccineType"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"location"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#location"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The service delivery location or facility in which the vaccine was / was to be administered"
},
"xpath":{
"value":"f:Immunization/f:location"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject of the vaccination event / refusal"
},
"xpath":{
"value":"f:Immunization/f:subject"
}
},
{
"name":{
"value":"manufacturer"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#manufacturer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Vaccine Manufacturer"
},
"xpath":{
"value":"f:Immunization/f:manufacturer"
}
},
{
"name":{
"value":"performer"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#performer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The practitioner who administered the vaccination"
},
"xpath":{
"value":"f:Immunization/f:performer"
}
},
{
"name":{
"value":"refusal-reason"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#refusal-reason"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Explanation of refusal / exemption"
},
"xpath":{
"value":"f:Immunization/f:explanation/f:refusalReason"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Immunization/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Vaccination Administration / Refusal Date"
},
"xpath":{
"value":"f:Immunization/f:date"
}
}
]
},
{
"type":{
"value":"ImmunizationProfile"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/ImmunizationProfile"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"vaccine-type"
},
"source":{
"value":"http://hl7.org/fhir/ImmunizationProfile/search#vaccine-type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Vaccine that pertains to the recommendation"
},
"xpath":{
"value":"f:ImmunizationProfile/f:recommendation/f:vaccineType"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/ImmunizationProfile/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/ImmunizationProfile/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who this profile is for"
},
"xpath":{
"value":"f:ImmunizationProfile/f:subject"
}
}
]
},
{
"type":{
"value":"List"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/List"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"source"
},
"source":{
"value":"http://hl7.org/fhir/List/search#source"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Source of the list"
},
"xpath":{
"value":"f:List/f:source"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/List/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"item"
},
"source":{
"value":"http://hl7.org/fhir/List/search#item"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Actual entry"
},
"xpath":{
"value":"f:List/f:entry/f:item"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/List/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"What the purpose of this list is"
},
"xpath":{
"value":"f:List/f:code"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/List/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When the list was prepared"
},
"xpath":{
"value":"f:List/f:date"
}
},
{
"name":{
"value":"empty-reason"
},
"source":{
"value":"http://hl7.org/fhir/List/search#empty-reason"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Why list is empty"
},
"xpath":{
"value":"f:List/f:emptyReason"
}
}
]
},
{
"type":{
"value":"Location"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Location"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"near"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#near"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The coordinates expressed as [lat],[long] (using KML, see notes) to find locations near to (servers may search using a square rather than a circle for efficiency)"
}
},
{
"name":{
"value":"partof"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#partof"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The location of which this location is a part"
},
"xpath":{
"value":"f:Location/f:partOf"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"address"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#address"
},
"type":{
"value":"string"
},
"documentation":{
"value":"A (part of the) address of the location"
},
"xpath":{
"value":"f:Location/f:address"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"A (portion of the) name of the location"
},
"xpath":{
"value":"f:Location/f:name"
}
},
{
"name":{
"value":"active"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#active"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Whether to search for active or inactive locations"
},
"xpath":{
"value":"f:Location/f:active"
}
},
{
"name":{
"value":"near-distance"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#near-distance"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A distance quantity to limit the near search to locations within a specific distance"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Location/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A code for the type of location"
},
"xpath":{
"value":"f:Location/f:type"
}
}
]
},
{
"type":{
"value":"Media"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Media"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who/What this Media is a record of"
},
"xpath":{
"value":"f:Media/f:subject"
}
},
{
"name":{
"value":"subtype"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#subtype"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The type of acquisition equipment/process"
},
"xpath":{
"value":"f:Media/f:subtype"
}
},
{
"name":{
"value":"view"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#view"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Imaging view e.g Lateral or Antero-posterior"
},
"xpath":{
"value":"f:Media/f:view"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When the media was taken/recorded"
},
"xpath":{
"value":"f:Media/f:dateTime"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"photo | audio | video"
},
"xpath":{
"value":"f:Media/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identifier(s) for the image"
},
"xpath":{
"value":"f:Media/f:identifier"
}
},
{
"name":{
"value":"operator"
},
"source":{
"value":"http://hl7.org/fhir/Media/search#operator"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The person who generated the image"
},
"xpath":{
"value":"f:Media/f:operator"
}
}
]
},
{
"type":{
"value":"Medication"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Medication"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"content"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#content"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"A product in the package"
},
"xpath":{
"value":"f:Medication/f:package/f:content/f:item"
}
},
{
"name":{
"value":"form"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#form"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Powder | tablets | carton etc"
},
"xpath":{
"value":"f:Medication/f:product/f:form"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"container"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#container"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Kind of container"
},
"xpath":{
"value":"f:Medication/f:package/f:container"
}
},
{
"name":{
"value":"manufacturer"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#manufacturer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Manufacturer of the item"
},
"xpath":{
"value":"f:Medication/f:manufacturer"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Common / Commercial name"
},
"xpath":{
"value":"f:Medication/f:name"
}
},
{
"name":{
"value":"ingredient"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#ingredient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Ingredient"
},
"xpath":{
"value":"f:Medication/f:product/f:ingredient/f:item"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/Medication/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"References to std. medication terminologies"
},
"xpath":{
"value":"f:Medication/f:code"
}
}
]
},
{
"type":{
"value":"MedicationAdministration"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/MedicationAdministration"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"medication"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#medication"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return administrations of this medication"
},
"xpath":{
"value":"f:MedicationAdministration/f:medication"
}
},
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a patient to list administrations for"
},
"xpath":{
"value":"f:MedicationAdministration/f:patient"
}
},
{
"name":{
"value":"administrationdevice"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#administrationdevice"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return administrations with this administration device identity"
},
"xpath":{
"value":"f:MedicationAdministration/f:administrationDevice"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"MedicationAdministration event status (for example one of active/paused/completed/nullified)"
},
"xpath":{
"value":"f:MedicationAdministration/f:status"
}
},
{
"name":{
"value":"prescription"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#prescription"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a prescription to list administrations from"
},
"xpath":{
"value":"f:MedicationAdministration/f:prescription"
}
},
{
"name":{
"value":"notgiven"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#notgiven"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Administrations that were not made"
},
"xpath":{
"value":"f:MedicationAdministration/f:wasNotGiven"
}
},
{
"name":{
"value":"whengiven"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#whengiven"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Date of administration"
},
"xpath":{
"value":"f:MedicationAdministration/f:whenGiven"
}
},
{
"name":{
"value":"encounter"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#encounter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return administrations that share this encounter"
},
"xpath":{
"value":"f:MedicationAdministration/f:encounter"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/MedicationAdministration/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Return administrations with this external identity"
},
"xpath":{
"value":"f:MedicationAdministration/f:identifier"
}
}
]
},
{
"type":{
"value":"MedicationDispense"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/MedicationDispense"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"medication"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#medication"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Returns dispenses of this medicine"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:medication"
}
},
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a patient to list dispenses for"
},
"xpath":{
"value":"f:MedicationDispense/f:patient"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Status of the dispense"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:status"
}
},
{
"name":{
"value":"prescription"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#prescription"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a prescription to list dispenses from"
},
"xpath":{
"value":"f:MedicationDispense/f:authorizingPrescription"
}
},
{
"name":{
"value":"responsibleparty"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#responsibleparty"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return all dispenses with the specified responsibel party"
},
"xpath":{
"value":"f:MedicationDispense/f:substitution/f:responsibleParty"
}
},
{
"name":{
"value":"dispenser"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#dispenser"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return all dispenses performed by a specific indiividual"
},
"xpath":{
"value":"f:MedicationDispense/f:dispenser"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Return all dispenses of a specific type"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Return dispenses with this external identity"
},
"xpath":{
"value":"f:MedicationDispense/f:identifier"
}
},
{
"name":{
"value":"whenprepared"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#whenprepared"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Date when medication prepared"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:whenPrepared"
}
},
{
"name":{
"value":"whenhandedover"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#whenhandedover"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:whenHandedOver"
}
},
{
"name":{
"value":"destination"
},
"source":{
"value":"http://hl7.org/fhir/MedicationDispense/search#destination"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return dispenses that should be sent to a secific destination"
},
"xpath":{
"value":"f:MedicationDispense/f:dispense/f:destination"
}
}
]
},
{
"type":{
"value":"MedicationPrescription"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/MedicationPrescription"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"medication"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#medication"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Code for medicine or text in medicine name"
},
"xpath":{
"value":"f:MedicationPrescription/f:medication"
}
},
{
"name":{
"value":"datewritten"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#datewritten"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Return prescriptions written on this date"
},
"xpath":{
"value":"f:MedicationPrescription/f:dateWritten"
}
},
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a patient to list dispenses for"
},
"xpath":{
"value":"f:MedicationPrescription/f:patient"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Status of the prescription"
},
"xpath":{
"value":"f:MedicationPrescription/f:status"
}
},
{
"name":{
"value":"encounter"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#encounter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return prescriptions with this encounter identity"
},
"xpath":{
"value":"f:MedicationPrescription/f:encounter"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/MedicationPrescription/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Return prescriptions with this external identity"
},
"xpath":{
"value":"f:MedicationPrescription/f:identifier"
}
}
]
},
{
"type":{
"value":"MedicationStatement"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/MedicationStatement"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"medication"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#medication"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Code for medicine or text in medicine name"
},
"xpath":{
"value":"f:MedicationStatement/f:medication"
}
},
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a patient to list administrations for"
},
"xpath":{
"value":"f:MedicationStatement/f:patient"
}
},
{
"name":{
"value":"administrationdevice"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#administrationdevice"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Return administrations with this administration device identity"
},
"xpath":{
"value":"f:MedicationStatement/f:administrationDevice"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"when-given"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#when-given"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Date of administration"
},
"xpath":{
"value":"f:MedicationStatement/f:whenGiven"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/MedicationStatement/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Return administrations with this external identity"
},
"xpath":{
"value":"f:MedicationStatement/f:identifier"
}
}
]
},
{
"type":{
"value":"Message"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Message"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Message/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
}
]
},
{
"type":{
"value":"Observation"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Observation"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The status of the observation"
},
"xpath":{
"value":"f:Observation/f:status"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The subject that the observation is about"
},
"xpath":{
"value":"f:Observation/f:subject"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The name of the observation type or component type"
},
"xpath":{
"value":"f:Observation/f:name"
}
},
{
"name":{
"value":"reliability"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#reliability"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The reliability of the observation"
},
"xpath":{
"value":"f:Observation/f:reliability"
}
},
{
"name":{
"value":"value"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#value"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The code or value of a result"
},
"xpath":{
"value":"f:Observation/f:value[x]"
}
},
{
"name":{
"value":"performer"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#performer"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"who/what performed the observation"
},
"xpath":{
"value":"f:Observation/f:performer"
}
},
{
"name":{
"value":"name-value"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#name-value"
},
"type":{
"value":"composite"
},
"documentation":{
"value":"Both name and value"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Observation/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"obtained date/time. If the obtained element is a period, a date that falls in the period"
},
"xpath":{
"value":"f:Observation/f:applies[x]"
}
}
]
},
{
"type":{
"value":"OperationOutcome"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/OperationOutcome"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/OperationOutcome/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
}
]
},
{
"type":{
"value":"Order"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Order"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"authority"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#authority"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"If required by policy"
},
"xpath":{
"value":"f:Order/f:authority"
}
},
{
"name":{
"value":"detail"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#detail"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"What action is being ordered"
},
"xpath":{
"value":"f:Order/f:detail"
}
},
{
"name":{
"value":"source"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#source"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who initiated the order"
},
"xpath":{
"value":"f:Order/f:source"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Patient this order is about"
},
"xpath":{
"value":"f:Order/f:subject"
}
},
{
"name":{
"value":"when"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#when"
},
"type":{
"value":"date"
},
"documentation":{
"value":"A formal schedule"
},
"xpath":{
"value":"f:Order/f:when/f:schedule"
}
},
{
"name":{
"value":"target"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#target"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who is intended to fulfill the order"
},
"xpath":{
"value":"f:Order/f:target"
}
},
{
"name":{
"value":"when_code"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#when_code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Code specifies when request should be done. The code may simply be a priority code"
},
"xpath":{
"value":"f:Order/f:when/f:code"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Order/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When the order was made"
},
"xpath":{
"value":"f:Order/f:date"
}
}
]
},
{
"type":{
"value":"OrderResponse"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/OrderResponse"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"authority"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#authority"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"If required by policy"
},
"xpath":{
"value":"f:OrderResponse/f:authority"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"fulfillment"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#fulfillment"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Details of the outcome of performing the order"
},
"xpath":{
"value":"f:OrderResponse/f:fulfillment"
}
},
{
"name":{
"value":"request"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#request"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The order that this is a response to"
},
"xpath":{
"value":"f:OrderResponse/f:request"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The status of the response"
},
"xpath":{
"value":"f:OrderResponse/f:code"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When the response was made"
},
"xpath":{
"value":"f:OrderResponse/f:date"
}
},
{
"name":{
"value":"cost"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#cost"
},
"type":{
"value":"integer"
},
"documentation":{
"value":"How much the request will/did cost"
},
"xpath":{
"value":"f:OrderResponse/f:cost"
}
},
{
"name":{
"value":"who"
},
"source":{
"value":"http://hl7.org/fhir/OrderResponse/search#who"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Who made the response"
},
"xpath":{
"value":"f:OrderResponse/f:who"
}
}
]
},
{
"type":{
"value":"Organization"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Organization"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"phonetic"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#phonetic"
},
"type":{
"value":"string"
},
"documentation":{
"value":"A portion of the organization's name using some kind of phonetic matching algorithm"
}
},
{
"name":{
"value":"partof"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#partof"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Search all organizations that are part of the given organization"
},
"xpath":{
"value":"f:Organization/f:partOf"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"A portion of the organization's name"
},
"xpath":{
"value":"f:Organization/f:name"
}
},
{
"name":{
"value":"active"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#active"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Whether the organization's record is active"
},
"xpath":{
"value":"f:Organization/f:active"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A code for the type of organization"
},
"xpath":{
"value":"f:Organization/f:type"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Organization/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Any identifier for the organization (not the accreditation issuer's identifier)"
},
"xpath":{
"value":"f:Organization/f:identifier"
}
}
]
},
{
"type":{
"value":"Other"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Other"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Other/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"created"
},
"source":{
"value":"http://hl7.org/fhir/Other/search#created"
},
"type":{
"value":"date"
},
"documentation":{
"value":"When created"
},
"xpath":{
"value":"f:Other/f:created"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Other/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Identifies the"
},
"xpath":{
"value":"f:Other/f:subject"
}
}
]
},
{
"type":{
"value":"Patient"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Patient"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"animal-breed"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#animal-breed"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the breed for animal patients"
}
},
{
"name":{
"value":"phonetic"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#phonetic"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of either family or given name using some kind of phonetic matching algorithm"
}
},
{
"name":{
"value":"provider"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#provider"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of the organization at which this person is a patient"
},
"xpath":{
"value":"f:Patient/f:provider"
}
},
{
"name":{
"value":"animal-species"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#animal-species"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the species for animal patients"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"given"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#given"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of the given name of the patient"
}
},
{
"name":{
"value":"address"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#address"
},
"type":{
"value":"string"
},
"documentation":{
"value":"an address in any kind of address/part of the patient"
}
},
{
"name":{
"value":"family"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#family"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of the family name of the patient"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of either family or given name of the patient"
}
},
{
"name":{
"value":"telecom"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#telecom"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the value in any kind of telecom details of the patient"
}
},
{
"name":{
"value":"birthdate"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#birthdate"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the patient's date of birth"
}
},
{
"name":{
"value":"gender"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#gender"
},
"type":{
"value":"token"
},
"documentation":{
"value":"gender of the patient"
}
},
{
"name":{
"value":"active"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#active"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Whether the patient record is active"
}
},
{
"name":{
"value":"language"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#language"
},
"type":{
"value":"token"
},
"documentation":{
"value":"language code (irrespective of use value)"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Patient/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A patient identifier"
}
}
]
},
{
"type":{
"value":"Practitioner"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Practitioner"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"organization"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#organization"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of the organization the practitioner represents / acts on behalf of"
},
"xpath":{
"value":"f:Practitioner/f:organization"
}
},
{
"name":{
"value":"phonetic"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#phonetic"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of either family or given name using some kind of phonetic matching algorithm"
},
"xpath":{
"value":"f:Practitioner/f:name"
}
},
{
"name":{
"value":"given"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#given"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of the given name"
},
"xpath":{
"value":"f:Practitioner/f:name"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"address"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#address"
},
"type":{
"value":"string"
},
"documentation":{
"value":"an address in any kind of address/part"
},
"xpath":{
"value":"f:Practitioner/f:address"
}
},
{
"name":{
"value":"family"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#family"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of the family name"
},
"xpath":{
"value":"f:Practitioner/f:name"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of either family or given name"
},
"xpath":{
"value":"f:Practitioner/f:name"
}
},
{
"name":{
"value":"telecom"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#telecom"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the value in any kind of contact"
},
"xpath":{
"value":"f:Practitioner/f:telecom"
}
},
{
"name":{
"value":"gender"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#gender"
},
"type":{
"value":"token"
},
"documentation":{
"value":"gender of the practitioner"
},
"xpath":{
"value":"f:Practitioner/f:gender"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Practitioner/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A practitioner's Identifier"
},
"xpath":{
"value":"f:Practitioner/f:identifier"
}
}
]
},
{
"type":{
"value":"Procedure"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Procedure"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Procedure/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Procedure/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The identity of a patient to list procedures for"
},
"xpath":{
"value":"f:Procedure/f:subject"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Procedure/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"the date the procedure was performed on"
},
"xpath":{
"value":"f:Procedure/f:date"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Procedure/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"type of procedure"
},
"xpath":{
"value":"f:Procedure/f:type"
}
}
]
},
{
"type":{
"value":"Profile"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Profile"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"extension"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#extension"
},
"type":{
"value":"token"
},
"documentation":{
"value":"An extension code (use or definition)"
}
},
{
"name":{
"value":"author"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#author"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Name or id of the author of the profile"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The current status of the profile"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"A portion of the name of the profile"
}
},
{
"name":{
"value":"resource"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#resource"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A resource constrained in a profile"
}
},
{
"name":{
"value":"binding"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#binding"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A vocabulary binding code"
}
},
{
"name":{
"value":"word"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#word"
},
"type":{
"value":"text"
},
"documentation":{
"value":"A word somewhere in the definition of the profile or the elements in the resource. (Common words - 'and', etc. - are often not supported)"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A code for the profile in the format uri::code (server may choose to do subsumption)"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The profile publication date"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Type of resource that is constrained in the profile"
}
},
{
"name":{
"value":"reference"
},
"source":{
"value":"http://hl7.org/fhir/Profile/search#reference"
},
"type":{
"value":"token"
},
"documentation":{
"value":"An id of another profile referenced in the profile"
}
}
]
},
{
"type":{
"value":"Provenance"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Provenance"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"location"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#location"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Where the activity occurred, if relevant"
},
"xpath":{
"value":"f:Provenance/f:location"
}
},
{
"name":{
"value":"start"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#start"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The start of the period"
},
"xpath":{
"value":"f:Provenance/f:period/f:start"
}
},
{
"name":{
"value":"partytype"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#partytype"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Resource | Person | Application | Record | Document +"
},
"xpath":{
"value":"f:Provenance/f:agent/f:type"
}
},
{
"name":{
"value":"target"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#target"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Target resource(s) (usually version specific)"
},
"xpath":{
"value":"f:Provenance/f:target"
}
},
{
"name":{
"value":"party"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#party"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identity of agent (urn or url)"
},
"xpath":{
"value":"f:Provenance/f:agent/f:reference"
}
},
{
"name":{
"value":"end"
},
"source":{
"value":"http://hl7.org/fhir/Provenance/search#end"
},
"type":{
"value":"date"
},
"documentation":{
"value":"The end of the period, if not ongoing"
},
"xpath":{
"value":"f:Provenance/f:period/f:end"
}
}
]
},
{
"type":{
"value":"Query"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Query"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"response"
},
"source":{
"value":"http://hl7.org/fhir/Query/search#response"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Links response to source query"
},
"xpath":{
"value":"f:Query/f:response/f:identifier"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Query/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Query/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Links query and its response(s)"
},
"xpath":{
"value":"f:Query/f:identifier"
}
}
]
},
{
"type":{
"value":"Questionnaire"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Questionnaire"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"author"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#author"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the author of the questionnaire"
},
"xpath":{
"value":"f:Questionnaire/f:author"
}
},
{
"name":{
"value":"authored"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#authored"
},
"type":{
"value":"date"
},
"documentation":{
"value":"when the questionnaire was authored"
},
"xpath":{
"value":"f:Questionnaire/f:authored"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The status of the questionnaire"
},
"xpath":{
"value":"f:Questionnaire/f:status"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the subject of the questionnaire"
},
"xpath":{
"value":"f:Questionnaire/f:subject"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"name of the questionnaire"
},
"xpath":{
"value":"f:Questionnaire/f:name"
}
},
{
"name":{
"value":"encounter"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#encounter"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"encounter during which questionnaire was authored"
},
"xpath":{
"value":"f:Questionnaire/f:encounter"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Questionnaire/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"an identifier for the questionnaire"
},
"xpath":{
"value":"f:Questionnaire/f:identifier"
}
}
]
},
{
"type":{
"value":"RelatedPerson"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/RelatedPerson"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"The patient this person is related to"
},
"xpath":{
"value":"f:RelatedPerson/f:patient"
}
},
{
"name":{
"value":"phonetic"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#phonetic"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of name using some kind of phonetic matching algorithm"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"address"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#address"
},
"type":{
"value":"string"
},
"documentation":{
"value":"an address in any kind of address/part"
},
"xpath":{
"value":"f:RelatedPerson/f:address"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of name in any name part"
},
"xpath":{
"value":"f:RelatedPerson/f:name"
}
},
{
"name":{
"value":"telecom"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#telecom"
},
"type":{
"value":"string"
},
"documentation":{
"value":"the value in any kind of contact"
},
"xpath":{
"value":"f:RelatedPerson/f:telecom"
}
},
{
"name":{
"value":"gender"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#gender"
},
"type":{
"value":"token"
},
"documentation":{
"value":"gender of the person"
},
"xpath":{
"value":"f:RelatedPerson/f:gender"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/RelatedPerson/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"A patient Identifier"
},
"xpath":{
"value":"f:RelatedPerson/f:identifier"
}
}
]
},
{
"type":{
"value":"SecurityEvent"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/SecurityEvent"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"site"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#site"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Logical source location within the enterprise"
},
"xpath":{
"value":"f:SecurityEvent/f:source/f:site"
}
},
{
"name":{
"value":"desc"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#desc"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Instance-specific descriptor for Object"
},
"xpath":{
"value":"f:SecurityEvent/f:object/f:name"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Type of event"
},
"xpath":{
"value":"f:SecurityEvent/f:event/f:type"
}
},
{
"name":{
"value":"date"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#date"
},
"type":{
"value":"date"
},
"documentation":{
"value":"Time when the event occurred on source"
},
"xpath":{
"value":"f:SecurityEvent/f:event/f:dateTime"
}
},
{
"name":{
"value":"reference"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#reference"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Specific instance of resource (e.g. versioned)"
},
"xpath":{
"value":"f:SecurityEvent/f:object/f:reference"
}
},
{
"name":{
"value":"authid"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#authid"
},
"type":{
"value":"token"
},
"documentation":{
"value":"User id used by authentication system"
},
"xpath":{
"value":"f:SecurityEvent/f:participant/f:authId"
}
},
{
"name":{
"value":"identity"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#identity"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Specific instance of object (e.g. versioned)"
},
"xpath":{
"value":"f:SecurityEvent/f:object/f:identifier"
}
},
{
"name":{
"value":"patientid"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#patientid"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The id of the patient (one of multiple kinds of participations)"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"source"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#source"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The id of source where event originated"
},
"xpath":{
"value":"f:SecurityEvent/f:source/f:identifier"
}
},
{
"name":{
"value":"address"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#address"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Identifier for the network access point of the user device"
},
"xpath":{
"value":"f:SecurityEvent/f:participant/f:network/f:identifier"
}
},
{
"name":{
"value":"subtype"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#subtype"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Sub-type of event"
},
"xpath":{
"value":"f:SecurityEvent/f:event/f:subtype"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Human-meaningful name for the user"
},
"xpath":{
"value":"f:SecurityEvent/f:participant/f:name"
}
},
{
"name":{
"value":"action"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#action"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Type of action performed during the event"
},
"xpath":{
"value":"f:SecurityEvent/f:event/f:action"
}
},
{
"name":{
"value":"object-type"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#object-type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Object type being audited"
},
"xpath":{
"value":"f:SecurityEvent/f:object/f:type"
}
},
{
"name":{
"value":"user"
},
"source":{
"value":"http://hl7.org/fhir/SecurityEvent/search#user"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Unique identifier for the user"
},
"xpath":{
"value":"f:SecurityEvent/f:participant/f:userId"
}
}
]
},
{
"type":{
"value":"Specimen"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Specimen"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Specimen/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"subject"
},
"source":{
"value":"http://hl7.org/fhir/Specimen/search#subject"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"the subject of the specimen"
},
"xpath":{
"value":"f:Specimen/f:subject"
}
}
]
},
{
"type":{
"value":"Substance"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Substance"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Substance/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Substance/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The name of the substance"
},
"xpath":{
"value":"f:Substance/f:name"
}
},
{
"name":{
"value":"type"
},
"source":{
"value":"http://hl7.org/fhir/Substance/search#type"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The type of the substance"
},
"xpath":{
"value":"f:Substance/f:type"
}
}
]
},
{
"type":{
"value":"Supply"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/Supply"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"patient"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#patient"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Patient"
},
"xpath":{
"value":"f:Supply/f:patient"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Dispensed|Received|Requested"
},
"xpath":{
"value":"f:Supply/f:status"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#name"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The kind of supply (central, non-stock, etc)"
},
"xpath":{
"value":"f:Supply/f:name"
}
},
{
"name":{
"value":"dispenseid"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#dispenseid"
},
"type":{
"value":"token"
},
"documentation":{
"value":"External identifier"
},
"xpath":{
"value":"f:Supply/f:dispense/f:identifier"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Unique identifier"
},
"xpath":{
"value":"f:Supply/f:identifier"
}
},
{
"name":{
"value":"supplier"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#supplier"
},
"type":{
"value":"reference"
},
"documentation":{
"value":"Dispenser"
},
"xpath":{
"value":"f:Supply/f:dispense/f:supplier"
}
},
{
"name":{
"value":"dispensestatus"
},
"source":{
"value":"http://hl7.org/fhir/Supply/search#dispensestatus"
},
"type":{
"value":"token"
},
"documentation":{
"value":"Active/Completed/Aborted"
},
"xpath":{
"value":"f:Supply/f:dispense/f:status"
}
}
]
},
{
"type":{
"value":"ValueSet"
},
"profile":{
"type":{
"value":"Profile"
},
"reference":{
"value":"http://hl7.org/fhir/ValueSet"
}
},
"operation":[
{
"code":{
"value":"read"
}
},
{
"code":{
"value":"vread"
}
},
{
"code":{
"value":"update"
}
},
{
"code":{
"value":"delete"
}
},
{
"code":{
"value":"history-instance"
}
},
{
"code":{
"value":"validate"
}
},
{
"code":{
"value":"history-type"
}
},
{
"code":{
"value":"create"
}
},
{
"code":{
"value":"search"
}
},
{
"code":{
"value":"transaction"
}
},
{
"code":{
"value":"history-system"
}
}
],
"searchParam":[
{
"name":{
"value":"system"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#system"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the system for any codes defined by this value set"
},
"xpath":{
"value":"f:ValueSet/f:define/f:system"
}
},
{
"name":{
"value":"_id"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#_id"
},
"type":{
"value":"token"
},
"documentation":{
"value":"The logical resource id associated with the resource (must be supported by all servers)"
}
},
{
"name":{
"value":"status"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#status"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the status of the value set"
},
"xpath":{
"value":"f:ValueSet/f:status"
}
},
{
"name":{
"value":"description"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#description"
},
"type":{
"value":"string"
},
"documentation":{
"value":"Human language description of the value set"
},
"xpath":{
"value":"f:ValueSet/f:description"
}
},
{
"name":{
"value":"name"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#name"
},
"type":{
"value":"string"
},
"documentation":{
"value":"a portion of the name of the value set"
},
"xpath":{
"value":"f:ValueSet/f:name"
}
},
{
"name":{
"value":"code"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#code"
},
"type":{
"value":"token"
},
"documentation":{
"value":"a code defined in the value set"
},
"xpath":{
"value":"f:ValueSet/f:define/f:concept/f:code"
}
},
{
"name":{
"value":"identifier"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#identifier"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the identifier of the value set"
},
"xpath":{
"value":"f:ValueSet/f:identifier"
}
},
{
"name":{
"value":"reference"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#reference"
},
"type":{
"value":"token"
},
"documentation":{
"value":"a code system included or excluded in the value set or an imported value set"
},
"xpath":{
"value":"f:ValueSet/f:compose/f:include/f:system"
}
},
{
"name":{
"value":"version"
},
"source":{
"value":"http://hl7.org/fhir/ValueSet/search#version"
},
"type":{
"value":"token"
},
"documentation":{
"value":"the version identifier of the value set"
},
"xpath":{
"value":"f:ValueSet/f:version"
}
}
]
}
],
"batch":{
"value":true
},
"history":{
"value":true
}
}
]
}
},
"summary":"<div><h2>Base FHIR Conformance Statement<\/h2><p>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<\/p><table><tr><td>Mode<\/td><td>server<\/td><\/tr><tr><td>Description<\/td><td>All the functionality defined in FHIR<\/td><\/tr><tr><td>Batch<\/td><td>y<\/td><\/tr><tr><td>System History<\/td><td>y<\/td><\/tr><\/table><table><tr><th><b>Resource Type<\/b><\/th><th><b>Profile<\/b><\/th><th><b>Read<\/b><\/th><th><b>V-Read<\/b><\/th><th><b>Search<\/b><\/th><th><b>Update<\/b><\/th><th><b>Updates<\/b><\/th><th><b>Create<\/b><\/th><th><b>Delete<\/b><\/th><th><b>History<\/b><\/th><\/tr><tr><td>AdverseReaction<\/td><td><a href=\"http://hl7.org/fhir/AdverseReaction\">http://hl7.org/fhir/AdverseReaction<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Alert<\/td><td><a href=\"http://hl7.org/fhir/Alert\">http://hl7.org/fhir/Alert<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>AllergyIntolerance<\/td><td><a href=\"http://hl7.org/fhir/AllergyIntolerance\">http://hl7.org/fhir/AllergyIntolerance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>CarePlan<\/td><td><a href=\"http://hl7.org/fhir/CarePlan\">http://hl7.org/fhir/CarePlan<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Condition<\/td><td><a href=\"http://hl7.org/fhir/Condition\">http://hl7.org/fhir/Condition<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Conformance<\/td><td><a href=\"http://hl7.org/fhir/Conformance\">http://hl7.org/fhir/Conformance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Coverage<\/td><td><a href=\"http://hl7.org/fhir/Coverage\">http://hl7.org/fhir/Coverage<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Device<\/td><td><a href=\"http://hl7.org/fhir/Device\">http://hl7.org/fhir/Device<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceCapabilities<\/td><td><a href=\"http://hl7.org/fhir/DeviceCapabilities\">http://hl7.org/fhir/DeviceCapabilities<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceLog<\/td><td><a href=\"http://hl7.org/fhir/DeviceLog\">http://hl7.org/fhir/DeviceLog<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DeviceObservation<\/td><td><a href=\"http://hl7.org/fhir/DeviceObservation\">http://hl7.org/fhir/DeviceObservation<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DiagnosticOrder<\/td><td><a href=\"http://hl7.org/fhir/DiagnosticOrder\">http://hl7.org/fhir/DiagnosticOrder<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DiagnosticReport<\/td><td><a href=\"http://hl7.org/fhir/DiagnosticReport\">http://hl7.org/fhir/DiagnosticReport<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Document<\/td><td><a href=\"http://hl7.org/fhir/Document\">http://hl7.org/fhir/Document<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>DocumentReference<\/td><td><a href=\"http://hl7.org/fhir/DocumentReference\">http://hl7.org/fhir/DocumentReference<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Encounter<\/td><td><a href=\"http://hl7.org/fhir/Encounter\">http://hl7.org/fhir/Encounter<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>FamilyHistory<\/td><td><a href=\"http://hl7.org/fhir/FamilyHistory\">http://hl7.org/fhir/FamilyHistory<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Group<\/td><td><a href=\"http://hl7.org/fhir/Group\">http://hl7.org/fhir/Group<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ImagingStudy<\/td><td><a href=\"http://hl7.org/fhir/ImagingStudy\">http://hl7.org/fhir/ImagingStudy<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Immunization<\/td><td><a href=\"http://hl7.org/fhir/Immunization\">http://hl7.org/fhir/Immunization<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ImmunizationProfile<\/td><td><a href=\"http://hl7.org/fhir/ImmunizationProfile\">http://hl7.org/fhir/ImmunizationProfile<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>List<\/td><td><a href=\"http://hl7.org/fhir/List\">http://hl7.org/fhir/List<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Location<\/td><td><a href=\"http://hl7.org/fhir/Location\">http://hl7.org/fhir/Location<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Media<\/td><td><a href=\"http://hl7.org/fhir/Media\">http://hl7.org/fhir/Media<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Medication<\/td><td><a href=\"http://hl7.org/fhir/Medication\">http://hl7.org/fhir/Medication<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationAdministration<\/td><td><a href=\"http://hl7.org/fhir/MedicationAdministration\">http://hl7.org/fhir/MedicationAdministration<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationDispense<\/td><td><a href=\"http://hl7.org/fhir/MedicationDispense\">http://hl7.org/fhir/MedicationDispense<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationPrescription<\/td><td><a href=\"http://hl7.org/fhir/MedicationPrescription\">http://hl7.org/fhir/MedicationPrescription<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>MedicationStatement<\/td><td><a href=\"http://hl7.org/fhir/MedicationStatement\">http://hl7.org/fhir/MedicationStatement<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Message<\/td><td><a href=\"http://hl7.org/fhir/Message\">http://hl7.org/fhir/Message<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Observation<\/td><td><a href=\"http://hl7.org/fhir/Observation\">http://hl7.org/fhir/Observation<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>OperationOutcome<\/td><td><a href=\"http://hl7.org/fhir/OperationOutcome\">http://hl7.org/fhir/OperationOutcome<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Order<\/td><td><a href=\"http://hl7.org/fhir/Order\">http://hl7.org/fhir/Order<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>OrderResponse<\/td><td><a href=\"http://hl7.org/fhir/OrderResponse\">http://hl7.org/fhir/OrderResponse<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Organization<\/td><td><a href=\"http://hl7.org/fhir/Organization\">http://hl7.org/fhir/Organization<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Other<\/td><td><a href=\"http://hl7.org/fhir/Other\">http://hl7.org/fhir/Other<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Patient<\/td><td><a href=\"http://hl7.org/fhir/Patient\">http://hl7.org/fhir/Patient<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Practitioner<\/td><td><a href=\"http://hl7.org/fhir/Practitioner\">http://hl7.org/fhir/Practitioner<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Procedure<\/td><td><a href=\"http://hl7.org/fhir/Procedure\">http://hl7.org/fhir/Procedure<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Profile<\/td><td><a href=\"http://hl7.org/fhir/Profile\">http://hl7.org/fhir/Profile<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Provenance<\/td><td><a href=\"http://hl7.org/fhir/Provenance\">http://hl7.org/fhir/Provenance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Query<\/td><td><a href=\"http://hl7.org/fhir/Query\">http://hl7.org/fhir/Query<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Questionnaire<\/td><td><a href=\"http://hl7.org/fhir/Questionnaire\">http://hl7.org/fhir/Questionnaire<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>RelatedPerson<\/td><td><a href=\"http://hl7.org/fhir/RelatedPerson\">http://hl7.org/fhir/RelatedPerson<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>SecurityEvent<\/td><td><a href=\"http://hl7.org/fhir/SecurityEvent\">http://hl7.org/fhir/SecurityEvent<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Specimen<\/td><td><a href=\"http://hl7.org/fhir/Specimen\">http://hl7.org/fhir/Specimen<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Substance<\/td><td><a href=\"http://hl7.org/fhir/Substance\">http://hl7.org/fhir/Substance<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>Supply<\/td><td><a href=\"http://hl7.org/fhir/Supply\">http://hl7.org/fhir/Supply<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><tr><td>ValueSet<\/td><td><a href=\"http://hl7.org/fhir/ValueSet\">http://hl7.org/fhir/ValueSet<\/a><\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><td>y<\/td><\/tr><\/table><\/div>"
},
{
"title":"\"adversereaction\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/adversereaction",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/adversereaction.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Specific reactions to a substance.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction\"><b>AdverseReaction<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"When the reaction occurred.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.reactionDate\"><b>reactionDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the reaction occurred<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The subject of the adverse reaction<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"To say that a reaction to substance did not occur (this element modifies the meaning of other elements)\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.didNotOccurFlag\"><span style=\"text-decoration: underline\"><b>didNotOccurFlag<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">To say that a reaction to substance did not occur<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who recorded the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.recorder\"><b>recorder<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who recorded the reaction<\/span><span style=\"color: Gray\"> --><\/span></recorder>\r\n <<a title=\"The signs and symptoms that were observed as part of the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom\"><b>symptom<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The signs and symptoms that were observed as part of the reaction --><\/span>\r\n <<a title=\"Indicates the specific sign or symptom that was observed.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://apps.who.int/classifications/icd10/browse/2010/en.htm\">Indicates the specific sign or symptom that was observed<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The severity of the sign or symptom.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom.severity\"><b>severity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"reactionSeverity.htm\">The severity of the sign or symptom<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </symptom>\r\n <<a title=\"An exposure to a substance that preceded a reaction occurrence.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure\"><b>exposure<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An exposure to a substance that preceded a reaction occurrence --><\/span>\r\n <<a title=\"When the exposure occurred.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.exposureDate\"><b>exposureDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the exposure occurred<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Drug Administration, Immunization, Coincidental.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.exposureType\"><b>exposureType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"exposureType.htm\">The type of exposure<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A statement of how confident that the recorder was that this exposure caused the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.causalityExpectation\"><b>causalityExpectation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"causalityExpectation.htm\">A statement of how confident that the recorder was that this exposure caused the reaction<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Substance(s) that is presumed to have caused the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.substance\"><b>substance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Substance(s) that is presumed to have caused the adverse reaction<\/span><span style=\"color: Gray\"> --><\/span></substance>\r\n </exposure>\r\n</AdverseReaction>\r\n<\/pre><\/div>"
},
"name":{
"value":"adversereaction"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Specific reactions to a substance."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"AdverseReaction"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"AdverseReaction"
},
"definition":{
"short":{
"value":"Specific reactions to a substance"
},
"formal":{
"value":"Specific reactions to a substance."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-11-Onset Date (Does not allow for IAM-12-Onset Date Text)"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.reactionDate"
},
"definition":{
"short":{
"value":"When the reaction occurred"
},
"formal":{
"value":"When the reaction occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.subject"
},
"definition":{
"short":{
"value":"The subject of the adverse reaction"
},
"formal":{
"value":"The subject of the adverse reaction."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.didNotOccurFlag"
},
"definition":{
"short":{
"value":"To say that a reaction to substance did not occur"
},
"formal":{
"value":"To say that a reaction to substance did not occur."
},
"comments":{
"value":"Note that the normal case is false, which is a double negative - it's not true that this reaction did not occur. The normal case is to assert that a reaction did happen."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
}
}
},
{
"path":{
"value":"AdverseReaction.recorder"
},
"definition":{
"short":{
"value":"Who recorded the reaction"
},
"formal":{
"value":"Who recorded the reaction."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.symptom"
},
"definition":{
"short":{
"value":"The signs and symptoms that were observed as part of the reaction"
},
"formal":{
"value":"The signs and symptoms that were observed as part of the reaction."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.symptom.code"
},
"definition":{
"short":{
"value":"Indicates the specific sign or symptom that was observed"
},
"formal":{
"value":"Indicates the specific sign or symptom that was observed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SymptomType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAR-1"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.symptom.severity"
},
"definition":{
"short":{
"value":"The severity of the sign or symptom"
},
"formal":{
"value":"The severity of the sign or symptom."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ReactionSeverity"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"AL1-4-Allergy Severity Code / IAM-4-Allergy Severity Code"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.exposure"
},
"definition":{
"short":{
"value":"An exposure to a substance that preceded a reaction occurrence"
},
"formal":{
"value":"An exposure to a substance that preceded a reaction occurrence."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AdverseReaction.exposure.exposureDate"
},
"definition":{
"short":{
"value":"When the exposure occurred"
},
"formal":{
"value":"When the exposure occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(V2 does not define distinct concepts of exposure date and reaction date)"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.exposure.exposureType"
},
"definition":{
"short":{
"value":"The type of exposure"
},
"formal":{
"value":"Drug Administration, Immunization, Coincidental."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ExposureType"
}
}
},
{
"path":{
"value":"AdverseReaction.exposure.causalityExpectation"
},
"definition":{
"short":{
"value":"A statement of how confident that the recorder was that this exposure caused the reaction"
},
"formal":{
"value":"A statement of how confident that the recorder was that this exposure caused the reaction."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CausalityExpectation"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-17-Allergy Clinical Status Code"
}
}
]
}
},
{
"path":{
"value":"AdverseReaction.exposure.substance"
},
"definition":{
"short":{
"value":"Substance(s) that is presumed to have caused the adverse reaction"
},
"formal":{
"value":"Substance(s) that is presumed to have caused the adverse reaction."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"AL1-3 / IAM-3 Allergen Code/Mnemonic/Description"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ReactionSeverity"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/reactionSeverity"
}
}
},
{
"name":{
"value":"ExposureType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/exposureType"
}
}
},
{
"name":{
"value":"CausalityExpectation"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/causalityExpectation"
}
}
},
{
"name":{
"value":"SymptomType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceUri":{
"value":"http://apps.who.int/classifications/icd10/browse/2010/en"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Specific reactions to a substance.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction\"><b>AdverseReaction<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"When the reaction occurred.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.reactionDate\"><b>reactionDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the reaction occurred<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The subject of the adverse reaction<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"To say that a reaction to substance did not occur (this element modifies the meaning of other elements)\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.didNotOccurFlag\"><span style=\"text-decoration: underline\"><b>didNotOccurFlag<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">To say that a reaction to substance did not occur<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who recorded the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.recorder\"><b>recorder<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who recorded the reaction<\/span><span style=\"color: Gray\"> --><\/span></recorder>\r\n <<a title=\"The signs and symptoms that were observed as part of the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom\"><b>symptom<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The signs and symptoms that were observed as part of the reaction --><\/span>\r\n <<a title=\"Indicates the specific sign or symptom that was observed.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://apps.who.int/classifications/icd10/browse/2010/en.htm\">Indicates the specific sign or symptom that was observed<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The severity of the sign or symptom.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.symptom.severity\"><b>severity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"reactionSeverity.htm\">The severity of the sign or symptom<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </symptom>\r\n <<a title=\"An exposure to a substance that preceded a reaction occurrence.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure\"><b>exposure<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An exposure to a substance that preceded a reaction occurrence --><\/span>\r\n <<a title=\"When the exposure occurred.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.exposureDate\"><b>exposureDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the exposure occurred<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Drug Administration, Immunization, Coincidental.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.exposureType\"><b>exposureType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"exposureType.htm\">The type of exposure<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A statement of how confident that the recorder was that this exposure caused the reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.causalityExpectation\"><b>causalityExpectation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"causalityExpectation.htm\">A statement of how confident that the recorder was that this exposure caused the reaction<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Substance(s) that is presumed to have caused the adverse reaction.\" class=\"dict\" href=\"adversereaction-definitions.htm#AdverseReaction.exposure.substance\"><b>substance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Substance(s) that is presumed to have caused the adverse reaction<\/span><span style=\"color: Gray\"> --><\/span></substance>\r\n </exposure>\r\n</AdverseReaction>\r\n<\/pre><\/div>"
},
{
"title":"\"alert\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/alert",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/alert.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Prospective warnings of potential issues when providing care to the patient.\" class=\"dict\" href=\"alert-definitions.htm#Alert\"><b>Alert<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Allows an alert to be divided into different categories like clinical, administrative etc.\" class=\"dict\" href=\"alert-definitions.htm#Alert.category\"><b>category<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The category of this alert<\/span><span style=\"color: Gray\"> --><\/span></category>\r\n <<a title=\"Supports basic workflow.\" class=\"dict\" href=\"alert-definitions.htm#Alert.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"alert-status.htm\">active | inactive | incorrect<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The person who this alert concerns.\" class=\"dict\" href=\"alert-definitions.htm#Alert.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this alert<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The person or device that created the alert.\" class=\"dict\" href=\"alert-definitions.htm#Alert.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Alert creator<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"The textual component of the alert to display to the user.\" class=\"dict\" href=\"alert-definitions.htm#Alert.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Text of alert<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Alert>\r\n<\/pre><\/div>"
},
"name":{
"value":"alert"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Prospective warnings of potential issues when providing care to the patient."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Alert"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Alert"
},
"definition":{
"short":{
"value":"Alert"
},
"formal":{
"value":"Prospective warnings of potential issues when providing care to the patient."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.category"
},
"definition":{
"short":{
"value":"The category of this alert"
},
"formal":{
"value":"Allows an alert to be divided into different categories like clinical, administrative etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.status"
},
"definition":{
"short":{
"value":"active | inactive | incorrect"
},
"formal":{
"value":"Supports basic workflow."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AlertStatus"
}
}
},
{
"path":{
"value":"Alert.subject"
},
"definition":{
"short":{
"value":"Subject of this alert"
},
"formal":{
"value":"The person who this alert concerns."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.author"
},
"definition":{
"short":{
"value":"Alert creator"
},
"formal":{
"value":"The person or device that created the alert."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Alert.note"
},
"definition":{
"short":{
"value":"Text of alert"
},
"formal":{
"value":"The textual component of the alert to display to the user."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"AlertStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/alert-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Prospective warnings of potential issues when providing care to the patient.\" class=\"dict\" href=\"alert-definitions.htm#Alert\"><b>Alert<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Allows an alert to be divided into different categories like clinical, administrative etc.\" class=\"dict\" href=\"alert-definitions.htm#Alert.category\"><b>category<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The category of this alert<\/span><span style=\"color: Gray\"> --><\/span></category>\r\n <<a title=\"Supports basic workflow.\" class=\"dict\" href=\"alert-definitions.htm#Alert.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"alert-status.htm\">active | inactive | incorrect<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The person who this alert concerns.\" class=\"dict\" href=\"alert-definitions.htm#Alert.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this alert<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The person or device that created the alert.\" class=\"dict\" href=\"alert-definitions.htm#Alert.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Alert creator<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"The textual component of the alert to display to the user.\" class=\"dict\" href=\"alert-definitions.htm#Alert.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Text of alert<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Alert>\r\n<\/pre><\/div>"
},
{
"title":"\"allergyintolerance\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/allergyintolerance",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/allergyintolerance.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Allergy/Intolerance.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance\"><b>AllergyIntolerance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An external identifier for the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An external identifier for the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Criticality of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.criticality\"><b>criticality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"criticality.htm\">Criticality of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.sensitivityType\"><b>sensitivityType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitytype.htm\">Type of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date when the sensitivity was recorded.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.recordedDate\"><b>recordedDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date when the sensitivity was recorded<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Suspected, Confirmed, Refuted, Resolved (this element modifies the meaning of other elements)\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitystatus.htm\">Status of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who the sensitivity is for.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who the sensitivity is for<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who recorded the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.recorder\"><b>recorder<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who recorded the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></recorder>\r\n <<a title=\"The substance that causes the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.substance\"><b>substance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">The substance that causes the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></substance>\r\n <<a title=\"Reactions associated with the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.reaction\"><b>reaction<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>)<\/span> <span style=\"color: navy\">Reactions associated with the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></reaction>\r\n <<a title=\"Observations that confirm or refute the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.sensitivityTest\"><b>sensitivityTest<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Observations that confirm or refute the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></sensitivityTest>\r\n</AllergyIntolerance>\r\n<\/pre><\/div>"
},
"name":{
"value":"allergyintolerance"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Allergy/Intolerance."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"AllergyIntolerance"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"AllergyIntolerance"
},
"definition":{
"short":{
"value":"Allergy/Intolerance"
},
"formal":{
"value":"Allergy/Intolerance."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AllergyIntolerance.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AllergyIntolerance.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AllergyIntolerance.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"AllergyIntolerance.identifier"
},
"definition":{
"short":{
"value":"An external identifier for the sensitivity"
},
"formal":{
"value":"An external identifier for the sensitivity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-7-Allergy Unique Identifier (Overloaded concept)"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.criticality"
},
"definition":{
"short":{
"value":"Criticality of the sensitivity"
},
"formal":{
"value":"Criticality of the sensitivity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Criticality"
}
}
},
{
"path":{
"value":"AllergyIntolerance.sensitivityType"
},
"definition":{
"short":{
"value":"Type of the sensitivity"
},
"formal":{
"value":"Type of the sensitivity."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SensitivityType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-9-Sensitivity to Causative Agent Code"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.recordedDate"
},
"definition":{
"short":{
"value":"Date when the sensitivity was recorded"
},
"formal":{
"value":"Date when the sensitivity was recorded."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-20-Statused at Date/Time"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.status"
},
"definition":{
"short":{
"value":"Status of the sensitivity"
},
"formal":{
"value":"Suspected, Confirmed, Refuted, Resolved."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"SensitivityStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-17-Allergy Clinical Status Code"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.subject"
},
"definition":{
"short":{
"value":"Who the sensitivity is for"
},
"formal":{
"value":"Who the sensitivity is for."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.recorder"
},
"definition":{
"short":{
"value":"Who recorded the sensitivity"
},
"formal":{
"value":"Who recorded the sensitivity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-14-Reported By (if patient) / IAM-18-Statused By Person (if practitioner)"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.substance"
},
"definition":{
"short":{
"value":"The substance that causes the sensitivity"
},
"formal":{
"value":"The substance that causes the sensitivity."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"AL1-3-Allergen Code/Mnemonic/Description / IAM-3-Allergen Code/Mnemonic/Description"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.reaction"
},
"definition":{
"short":{
"value":"Reactions associated with the sensitivity"
},
"formal":{
"value":"Reactions associated with the sensitivity."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(AdverseReaction)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM-7-Allergy Unique Identifier (Overloaded concept)"
}
}
]
}
},
{
"path":{
"value":"AllergyIntolerance.sensitivityTest"
},
"definition":{
"short":{
"value":"Observations that confirm or refute the sensitivity"
},
"formal":{
"value":"Observations that confirm or refute the sensitivity."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Observation)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-21-Observation Instance Identifier\n(Subject to Ch7 caveats)"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"SensitivityStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/sensitivitystatus"
}
}
},
{
"name":{
"value":"Criticality"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/criticality"
}
}
},
{
"name":{
"value":"SensitivityType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/sensitivitytype"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Allergy/Intolerance.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance\"><b>AllergyIntolerance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An external identifier for the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An external identifier for the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Criticality of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.criticality\"><b>criticality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"criticality.htm\">Criticality of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.sensitivityType\"><b>sensitivityType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitytype.htm\">Type of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date when the sensitivity was recorded.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.recordedDate\"><b>recordedDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date when the sensitivity was recorded<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Suspected, Confirmed, Refuted, Resolved (this element modifies the meaning of other elements)\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"sensitivitystatus.htm\">Status of the sensitivity<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who the sensitivity is for.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who the sensitivity is for<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who recorded the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.recorder\"><b>recorder<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who recorded the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></recorder>\r\n <<a title=\"The substance that causes the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.substance\"><b>substance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">The substance that causes the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></substance>\r\n <<a title=\"Reactions associated with the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.reaction\"><b>reaction<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>)<\/span> <span style=\"color: navy\">Reactions associated with the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></reaction>\r\n <<a title=\"Observations that confirm or refute the sensitivity.\" class=\"dict\" href=\"allergyintolerance-definitions.htm#AllergyIntolerance.sensitivityTest\"><b>sensitivityTest<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Observations that confirm or refute the sensitivity<\/span><span style=\"color: Gray\"> --><\/span></sensitivityTest>\r\n</AllergyIntolerance>\r\n<\/pre><\/div>"
},
{
"title":"\"careplan\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/careplan",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/careplan.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan\"><b>CarePlan<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Unique identifier by which the care plan is known in different business contexts.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">ID for plan<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies the patient/subject whose intended care is described by the plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who care plan is for<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-status.htm\">planned | active | ended<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates when the plan did (or is intended to) come into effect and end.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time period plan covers<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Identifies the most recent date on which the plan has been revised.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.modified\"><b>modified<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When last updated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.concern\"><b>concern<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"condition.htm#Condition\">Condition<\/a>)<\/span> <span style=\"color: navy\">Health issues plan addresses<\/span><span style=\"color: Gray\"> --><\/span></concern>\r\n <<a title=\"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Who's involved in plan? --><\/span>\r\n <<a title=\"Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Type of involvement<\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"The specific person or organization who is participating/expected to participate in the care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant.member\"><b>member<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who is involved<\/span><span style=\"color: Gray\"> --><\/span></member>\r\n </participant>\r\n <<a title=\"Describes the intended objective(s) of carrying out the Care Plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal\"><b>goal<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Desired outcome of plan --><\/span>\r\n <<a title=\"Human readable description of a specific desired objective of the care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">What's the desired outcome?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates whether the goal has been reached and is still considered relevant.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-goal-status.htm\">in progress | achieved | sustaining | abandoned<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Any comments related to the goal.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the goal<\/span><span style=\"color: Gray\"> --><\/span>\r\n </goal>\r\n <<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity\"><b>activity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Action to occur as part of plan --><\/span>\r\n <<a title=\"High-level categorization of the type of activity in a care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.category\"><b>category<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-category.htm\">encounter | procedure | observation | +<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Detail type of activity<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies what progress is being made for the specific activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-status.htm\">not started | ongoing | suspended | completed | abandoned<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, indicates that the described activity is one that must NOT be engaged in when following the plan (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.prohibited\"><span style=\"text-decoration: underline\"><b>prohibited<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Do NOT do<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The period, timing or frequency upon which the described activity is to occur.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">When activity is to occur<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where it should happen<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Identifies who's expected to be involved in the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who's responsible?<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Identifies the food, drug or other product being consumed or supplied in the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.product\"><b>product<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">What's administered/supplied<\/span><span style=\"color: Gray\"> --><\/span></product>\r\n <<a title=\"Identifies the quantity expected to be consumed in a given day.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.dailyAmount\"><b>dailyAmount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: DailyDose can only be specified if activity category is drug or food\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">How much consumed/day?<\/span><span style=\"color: Gray\"> --><\/span></dailyAmount>\r\n <<a title=\"Identifies the quantity expected to be supplied.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Quantity can only be specified if activity category is supply\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">How much is administered/supplied/consumed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.details\"><b>details<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Extra info on activity occurrence<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.actionTaken\"><b>actionTaken<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Appointments, orders, etc.<\/span><span style=\"color: Gray\"> --><\/span></actionTaken>\r\n <<a title=\"Notes about the execution of the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the activity<\/span><span style=\"color: Gray\"> --><\/span>\r\n </activity>\r\n <<a title=\"General notes about the care plan not covered elsewhere.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the plan<\/span><span style=\"color: Gray\"> --><\/span>\r\n</CarePlan>\r\n<\/pre><\/div>"
},
"name":{
"value":"careplan"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"CarePlan"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"CarePlan"
},
"definition":{
"short":{
"value":"Healthcare plan for patient"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.identifier"
},
"definition":{
"short":{
"value":"ID for plan"
},
"formal":{
"value":"Unique identifier by which the care plan is known in different business contexts."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PTH-3-pathway instance ID"
}
}
]
}
},
{
"path":{
"value":"CarePlan.patient"
},
"definition":{
"short":{
"value":"Who care plan is for"
},
"formal":{
"value":"Identifies the patient/subject whose intended care is described by the plan."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"CarePlan.status"
},
"definition":{
"short":{
"value":"planned | active | ended"
},
"formal":{
"value":"Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"CarePlanStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PTH-5-pathway life cycle status"
}
}
]
}
},
{
"path":{
"value":"CarePlan.period"
},
"definition":{
"short":{
"value":"Time period plan covers"
},
"formal":{
"value":"Indicates when the plan did (or is intended to) come into effect and end."
},
"comments":{
"value":"Any activities scheduled as part of the plan should be constrained to the specified period."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"GOL-7-goal established date/time / GOL-8-expected goal achieve date/time"
}
}
]
}
},
{
"path":{
"value":"CarePlan.modified"
},
"definition":{
"short":{
"value":"When last updated"
},
"formal":{
"value":"Identifies the most recent date on which the plan has been revised."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PTH-6-change pathway life cycle status date/time"
}
}
]
}
},
{
"path":{
"value":"CarePlan.concern"
},
"definition":{
"short":{
"value":"Health issues plan addresses"
},
"formal":{
"value":"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Condition)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-4-Problem instance ID"
}
}
]
}
},
{
"path":{
"value":"CarePlan.participant"
},
"definition":{
"short":{
"value":"Who's involved in plan?"
},
"formal":{
"value":"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"REL (REL.4 is always the Patient) ( or PRT?)"
}
}
]
}
},
{
"path":{
"value":"CarePlan.participant.role"
},
"definition":{
"short":{
"value":"Type of involvement"
},
"formal":{
"value":"Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CarePlanParticipantRole"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"REL.2 (or PRT-4-participation?)"
}
}
]
}
},
{
"path":{
"value":"CarePlan.participant.member"
},
"definition":{
"short":{
"value":"Who is involved"
},
"formal":{
"value":"The specific person or organization who is participating/expected to participate in the care plan."
},
"comments":{
"value":"Patient only needs to be listed if they have a role other than \"subject of care\"."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|RelatedPerson|Patient|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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?)"
}
}
]
}
},
{
"path":{
"value":"CarePlan.goal"
},
"definition":{
"short":{
"value":"Desired outcome of plan"
},
"formal":{
"value":"Describes the intended objective(s) of carrying out the Care Plan."
},
"comments":{
"value":"Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"GOL.1"
}
}
]
}
},
{
"path":{
"value":"CarePlan.goal.description"
},
"definition":{
"short":{
"value":"What's the desired outcome?"
},
"formal":{
"value":"Human readable description of a specific desired objective of the care plan."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"GOL-3.2-goal ID.text"
}
}
]
}
},
{
"path":{
"value":"CarePlan.goal.status"
},
"definition":{
"short":{
"value":"in progress | achieved | sustaining | abandoned"
},
"formal":{
"value":"Indicates whether the goal has been reached and is still considered relevant."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CarePlanGoalStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"GOL-18-goal life cycle status"
}
}
]
}
},
{
"path":{
"value":"CarePlan.goal.notes"
},
"definition":{
"short":{
"value":"Comments about the goal"
},
"formal":{
"value":"Any comments related to the goal."
},
"comments":{
"value":"May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"GOL-16-goal evaluation + NTE?"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity"
},
"definition":{
"short":{
"value":"Action to occur as part of plan"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"quantity for supply"
},
"severity":{
"value":"error"
},
"human":{
"value":"Quantity can only be specified if activity category is supply"
},
"xpath":{
"value":"(f:category/@value=('supply')) = exists(f:quantity)"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"dose for food or drug"
},
"severity":{
"value":"error"
},
"human":{
"value":"DailyDose can only be specified if activity category is drug or food"
},
"xpath":{
"value":"(f:category/@value=('drug','diet')) = exists(f:dailyAmount)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.activity.category"
},
"definition":{
"short":{
"value":"encounter | procedure | observation | +"
},
"formal":{
"value":"High-level categorization of the type of activity in a care plan."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CarePlanActivityCategory"
}
}
},
{
"path":{
"value":"CarePlan.activity.code"
},
"definition":{
"short":{
"value":"Detail type of activity"
},
"formal":{
"value":"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."
},
"comments":{
"value":"Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CarePlanActivityCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-4-universal service ID / RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.status"
},
"definition":{
"short":{
"value":"not started | ongoing | suspended | completed | abandoned"
},
"formal":{
"value":"Identifies what progress is being made for the specific activity."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CarePlanActivityStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-5-order status?"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.prohibited"
},
"definition":{
"short":{
"value":"Do NOT do"
},
"formal":{
"value":"If true, indicates that the described activity is one that must NOT be engaged in when following the plan."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
}
}
},
{
"path":{
"value":"CarePlan.activity.timing[x]"
},
"definition":{
"short":{
"value":"When activity is to occur"
},
"formal":{
"value":"The period, timing or frequency upon which the described activity is to occur."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Schedule"
}
},
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TQ1"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.location"
},
"definition":{
"short":{
"value":"Where it should happen"
},
"formal":{
"value":"Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc."
},
"comments":{
"value":"May reference a specific clinical location or may just identify a type of location."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-24-diagnostic service section ID (???!!)"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.performer"
},
"definition":{
"short":{
"value":"Who's responsible?"
},
"formal":{
"value":"Identifies who's expected to be involved in the activity."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Organization|RelatedPerson|Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.product"
},
"definition":{
"short":{
"value":"What's administered/supplied"
},
"formal":{
"value":"Identifies the food, drug or other product being consumed or supplied in the activity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication|Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.dailyAmount"
},
"definition":{
"short":{
"value":"How much consumed/day?"
},
"formal":{
"value":"Identifies the quantity expected to be consumed in a given day."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXO-23-total daily dose / RXE-19-total daily dose / RXD-12-total daily dose"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.quantity"
},
"definition":{
"short":{
"value":"How much is administered/supplied/consumed"
},
"formal":{
"value":"Identifies the quantity expected to be supplied."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.details"
},
"definition":{
"short":{
"value":"Extra info on activity occurrence"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NTE?"
}
}
]
}
},
{
"path":{
"value":"CarePlan.activity.actionTaken"
},
"definition":{
"short":{
"value":"Appointments, orders, etc."
},
"formal":{
"value":"Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"CarePlan.activity.notes"
},
"definition":{
"short":{
"value":"Comments about the activity"
},
"formal":{
"value":"Notes about the execution of the activity."
},
"comments":{
"value":"Doesn't describe the activity - that goes in details."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NTE?"
}
}
]
}
},
{
"path":{
"value":"CarePlan.notes"
},
"definition":{
"short":{
"value":"Comments about the plan"
},
"formal":{
"value":"General notes about the care plan not covered elsewhere."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NTE?"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"CarePlanActivityCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter."
}
},
{
"name":{
"value":"CarePlanStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/care-plan-status"
}
}
},
{
"name":{
"value":"CarePlanActivityCategory"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/care-plan-activity-category"
}
}
},
{
"name":{
"value":"CarePlanGoalStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/care-plan-goal-status"
}
}
},
{
"name":{
"value":"CarePlanParticipantRole"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Indicates specific responsibility of an individual within the care plan. E.g. \"Primary physician\", \"Team coordinator\", \"Caregiver\", etc."
}
},
{
"name":{
"value":"CarePlanActivityStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/care-plan-activity-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan\"><b>CarePlan<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Unique identifier by which the care plan is known in different business contexts.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">ID for plan<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies the patient/subject whose intended care is described by the plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who care plan is for<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Indicates whether the plan is currently being acted upon, represents future intentions or is now just historical record (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-status.htm\">planned | active | ended<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates when the plan did (or is intended to) come into effect and end.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time period plan covers<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Identifies the most recent date on which the plan has been revised.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.modified\"><b>modified<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When last updated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.concern\"><b>concern<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"condition.htm#Condition\">Condition<\/a>)<\/span> <span style=\"color: navy\">Health issues plan addresses<\/span><span style=\"color: Gray\"> --><\/span></concern>\r\n <<a title=\"Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Who's involved in plan? --><\/span>\r\n <<a title=\"Indicates specific responsibility of an individual within the care plan. E.g. "Primary physician", "Team coordinator", "Caregiver", etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Type of involvement<\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"The specific person or organization who is participating/expected to participate in the care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.participant.member\"><b>member<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who is involved<\/span><span style=\"color: Gray\"> --><\/span></member>\r\n </participant>\r\n <<a title=\"Describes the intended objective(s) of carrying out the Care Plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal\"><b>goal<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Desired outcome of plan --><\/span>\r\n <<a title=\"Human readable description of a specific desired objective of the care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">What's the desired outcome?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates whether the goal has been reached and is still considered relevant.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-goal-status.htm\">in progress | achieved | sustaining | abandoned<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Any comments related to the goal.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.goal.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the goal<\/span><span style=\"color: Gray\"> --><\/span>\r\n </goal>\r\n <<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity\"><b>activity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Action to occur as part of plan --><\/span>\r\n <<a title=\"High-level categorization of the type of activity in a care plan.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.category\"><b>category<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-category.htm\">encounter | procedure | observation | +<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Detailed description of the type of activity. E.g. What lab test, what procedure, what kind of encounter.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Detail type of activity<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies what progress is being made for the specific activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"care-plan-activity-status.htm\">not started | ongoing | suspended | completed | abandoned<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, indicates that the described activity is one that must NOT be engaged in when following the plan (this element modifies the meaning of other elements)\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.prohibited\"><span style=\"text-decoration: underline\"><b>prohibited<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Do NOT do<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The period, timing or frequency upon which the described activity is to occur.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">When activity is to occur<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"Identifies the facility where the activity will occur. E.g. home, hospital, specific clinic, etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where it should happen<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Identifies who's expected to be involved in the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who's responsible?<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Identifies the food, drug or other product being consumed or supplied in the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.product\"><b>product<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">What's administered/supplied<\/span><span style=\"color: Gray\"> --><\/span></product>\r\n <<a title=\"Identifies the quantity expected to be consumed in a given day.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.dailyAmount\"><b>dailyAmount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: DailyDose can only be specified if activity category is drug or food\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">How much consumed/day?<\/span><span style=\"color: Gray\"> --><\/span></dailyAmount>\r\n <<a title=\"Identifies the quantity expected to be supplied.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Quantity can only be specified if activity category is supply\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">How much is administered/supplied/consumed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.details\"><b>details<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Extra info on activity occurrence<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.actionTaken\"><b>actionTaken<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Appointments, orders, etc.<\/span><span style=\"color: Gray\"> --><\/span></actionTaken>\r\n <<a title=\"Notes about the execution of the activity.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.activity.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the activity<\/span><span style=\"color: Gray\"> --><\/span>\r\n </activity>\r\n <<a title=\"General notes about the care plan not covered elsewhere.\" class=\"dict\" href=\"careplan-definitions.htm#CarePlan.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the plan<\/span><span style=\"color: Gray\"> --><\/span>\r\n</CarePlan>\r\n<\/pre><\/div>"
},
{
"title":"\"condition\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/condition",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/condition.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"condition-definitions.htm#Condition\"><b>Condition<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Subject of this condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this condition<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Encounter during which the condition was first asserted.\" class=\"dict\" href=\"condition-definitions.htm#Condition.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Encounter during which the condition was first asserted<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Person who takes responsibility for asserting the existence of the condition as part of the electronic record.\" class=\"dict\" href=\"condition-definitions.htm#Condition.asserter\"><b>asserter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Person who asserts this condition<\/span><span style=\"color: Gray\"> --><\/span></asserter>\r\n <<a title=\"Estimated or actual date the condition/problem/diagnosis was first detected/suspected.\" class=\"dict\" href=\"condition-definitions.htm#Condition.dateAsserted\"><b>dateAsserted<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When first detected/suspected/entered<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identification of the condition, problem or diagnosis.\" class=\"dict\" href=\"condition-definitions.htm#Condition.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.htm\">Identification of the condition, problem or diagnosis<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A category assigned to the condition. E.g. finding | Condition | diagnosis | concern | condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.category\"><b>category<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-category.htm\">E.g. complaint | symptom | finding | diagnosis<\/a><\/span><span style=\"color: Gray\"> --><\/span></category>\r\n <<a title=\"The clinical status of the condition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.htm#Condition.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-status.htm\">provisional | working | confirmed | refuted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The degree of confidence that this condition is correct (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.htm#Condition.certainty\"><span style=\"text-decoration: underline\"><b>certainty<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-certainty.htm\">Degree of confidence<\/a><\/span><span style=\"color: Gray\"> --><\/span></certainty>\r\n <<a title=\"A subjective assessment of the severity of the condition as evaluated by the clinician.\" class=\"dict\" href=\"condition-definitions.htm#Condition.severity\"><b>severity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-severity.htm\">Subjective severity of condition<\/a><\/span><span style=\"color: Gray\"> --><\/span></severity>\r\n <<a title=\"Estimated or actual date the condition began, in the opinion of the clinician.\" class=\"dict\" href=\"condition-definitions.htm#Condition.onset_x_\"><b>onset[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a><\/span> <span style=\"color: navy\">Estimated or actual date, or age<\/span><span style=\"color: Gray\"> --><\/span></onset[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"condition-definitions.htm#Condition.abatement_x_\"><b>abatement[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a><\/span> <span style=\"color: navy\">If/when in resolution/remission<\/span><span style=\"color: Gray\"> --><\/span></abatement[x]>\r\n <<a title=\"Clinical stage or grade of a condition. May include formal severity assessments.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage\"><b>stage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Stage/grade, usually assessed formally --><\/span>\r\n <<a title=\"A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage.summary\"><b>summary<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Stage must have summary or assessment\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Simple summary (disease specific)<\/span><span style=\"color: Gray\"> --><\/span></summary>\r\n <<a title=\"Reference to a formal record of the evidence on which the staging assessment is based.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage.assessment\"><b>assessment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Stage must have summary or assessment\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Formal record of assessment<\/span><span style=\"color: Gray\"> --><\/span></assessment>\r\n </stage>\r\n <<a title=\"Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence\"><b>evidence<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supporting evidence --><\/span>\r\n <<a title=\"A manifestation or symptom that led to the recording of this condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: evidence must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Manifestation/symptom<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Links to other relevant information, including pathology reports.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: evidence must have code or details\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Supporting information found elsewhere<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n </evidence>\r\n <<a title=\"The anatomical location where this condition manifests itself.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location\"><b>location<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Anatomical location, if relevant --><\/span>\r\n <<a title=\"Code that identifies the structural location.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: location must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Location - may include laterality<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Detailed anatomical location information.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location.detail\"><b>detail<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: location must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Precise location details<\/span><span style=\"color: Gray\"> --><\/span>\r\n </location>\r\n <<a title=\"Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem\"><b>relatedItem<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Causes or precedents for this Condition --><\/span>\r\n <<a title=\"The type of relationship that this condition has to the related item.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-relationship-type.htm\">due-to | follows<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the target of this relationship. The code takes the place of a detailed instance target.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Relationship must have either a code or a target\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.htm\">Relationship target by means of a predefined code<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Target of the relationship.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Relationship must have either a code or a target\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"condition.htm#Condition\">Condition<\/a>|<a href=\"procedure.htm#Procedure\">Procedure<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Relationship target resource<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </relatedItem>\r\n <<a title=\"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.\" class=\"dict\" href=\"condition-definitions.htm#Condition.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional information about the Condition<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Condition>\r\n<\/pre><\/div>"
},
"name":{
"value":"condition"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Condition"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Condition"
},
"definition":{
"short":{
"value":"Detailed information about conditions, problems or diagnoses"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PPR message"
}
}
]
}
},
{
"path":{
"value":"Condition.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.subject"
},
"definition":{
"short":{
"value":"Subject of this condition"
},
"formal":{
"value":"Subject of this condition."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3"
}
}
]
}
},
{
"path":{
"value":"Condition.encounter"
},
"definition":{
"short":{
"value":"Encounter during which the condition was first asserted"
},
"formal":{
"value":"Encounter during which the condition was first asserted."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-19 (+PV1-54)"
}
}
]
}
},
{
"path":{
"value":"Condition.asserter"
},
"definition":{
"short":{
"value":"Person who asserts this condition"
},
"formal":{
"value":"Person who takes responsibility for asserting the existence of the condition as part of the electronic record."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"REL-7.1 identifier + REL-7.12 type code"
}
}
]
}
},
{
"path":{
"value":"Condition.dateAsserted"
},
"definition":{
"short":{
"value":"When first detected/suspected/entered"
},
"formal":{
"value":"Estimated or actual date the condition/problem/diagnosis was first detected/suspected."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"REL-11"
}
}
]
}
},
{
"path":{
"value":"Condition.code"
},
"definition":{
"short":{
"value":"Identification of the condition, problem or diagnosis"
},
"formal":{
"value":"Identification of the condition, problem or diagnosis."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-3"
}
}
]
}
},
{
"path":{
"value":"Condition.category"
},
"definition":{
"short":{
"value":"E.g. complaint | symptom | finding | diagnosis"
},
"formal":{
"value":"A category assigned to the condition. E.g. finding | Condition | diagnosis | concern | condition."
},
"comments":{
"value":"The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionCategory"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"'problem' if from PRB-3. 'diagnosis' if from DG1 segment in PV1 message"
}
}
]
}
},
{
"path":{
"value":"Condition.status"
},
"definition":{
"short":{
"value":"provisional | working | confirmed | refuted"
},
"formal":{
"value":"The clinical status of the condition."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ConditionStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-14 / DG1-6"
}
}
]
}
},
{
"path":{
"value":"Condition.certainty"
},
"definition":{
"short":{
"value":"Degree of confidence"
},
"formal":{
"value":"The degree of confidence that this condition is correct."
},
"comments":{
"value":"May be a percentage."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ConditionCertainty"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-19"
}
}
]
}
},
{
"path":{
"value":"Condition.severity"
},
"definition":{
"short":{
"value":"Subjective severity of condition"
},
"formal":{
"value":"A subjective assessment of the severity of the condition as evaluated by the clinician."
},
"comments":{
"value":"Coding of the severity with a terminology is preferred, where possible."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionSeverity"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-26 / ABS-3"
}
}
]
}
},
{
"path":{
"value":"Condition.onset[x]"
},
"definition":{
"short":{
"value":"Estimated or actual date, or age"
},
"formal":{
"value":"Estimated or actual date the condition began, in the opinion of the clinician."
},
"comments":{
"value":"Age is generally used when the patient reports an age at which the Condition began to occur."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
},
{
"code":{
"value":"Age"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRB-16"
}
}
]
}
},
{
"path":{
"value":"Condition.abatement[x]"
},
"definition":{
"short":{
"value":"If/when in resolution/remission"
},
"formal":{
"value":"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":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
},
{
"code":{
"value":"Age"
}
},
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.stage"
},
"definition":{
"short":{
"value":"Stage/grade, usually assessed formally"
},
"formal":{
"value":"Clinical stage or grade of a condition. May include formal severity assessments."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"Stage rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"Stage must have summary or assessment"
},
"xpath":{
"value":"exists(f:summary) or exists(f:assessment)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.stage.summary"
},
"definition":{
"short":{
"value":"Simple summary (disease specific)"
},
"formal":{
"value":"A simple summary of the stage such as \"Stage 3\". The determination of the stage is disease-specific."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.stage.assessment"
},
"definition":{
"short":{
"value":"Formal record of assessment"
},
"formal":{
"value":"Reference to a formal record of the evidence on which the staging assessment is based."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.evidence"
},
"definition":{
"short":{
"value":"Supporting evidence"
},
"formal":{
"value":"Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed."
},
"comments":{
"value":"The evidence may be a simple lost of coded symptoms/manifestations, or references to observations or formal assessments, or both."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"Evidence"
},
"severity":{
"value":"error"
},
"human":{
"value":"evidence must have code or details"
},
"xpath":{
"value":"exists(f:code) or exists(f:detail)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.evidence.code"
},
"definition":{
"short":{
"value":"Manifestation/symptom"
},
"formal":{
"value":"A manifestation or symptom that led to the recording of this condition."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.evidence.detail"
},
"definition":{
"short":{
"value":"Supporting information found elsewhere"
},
"formal":{
"value":"Links to other relevant information, including pathology reports."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.location"
},
"definition":{
"short":{
"value":"Anatomical location, if relevant"
},
"formal":{
"value":"The anatomical location where this condition manifests itself."
},
"comments":{
"value":"May be a summary code, or a reference to a very precise definition of the location, or both."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"Location"
},
"severity":{
"value":"error"
},
"human":{
"value":"location must have code or details"
},
"xpath":{
"value":"exists(f:code) or exists(f:detail)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.location.code"
},
"definition":{
"short":{
"value":"Location - may include laterality"
},
"formal":{
"value":"Code that identifies the structural location."
},
"comments":{
"value":"May include laterality."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.location.detail"
},
"definition":{
"short":{
"value":"Precise location details"
},
"formal":{
"value":"Detailed anatomical location information."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.relatedItem"
},
"definition":{
"short":{
"value":"Causes or precedents for this Condition"
},
"formal":{
"value":"Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition."
},
"comments":{
"value":"Although a condition may be caused by a substance, this is not intended to be used to record allergies/adverse reactions to substances."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"4"
},
"name":{
"value":"Relationship"
},
"severity":{
"value":"error"
},
"human":{
"value":"Relationship must have either a code or a target"
},
"xpath":{
"value":"exists(f:code) != exists(f:target)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"could infer from presence of multiple PRB segments in a PPR message that the problems are related, but not clear how to communicate the nature of the relationship"
}
}
]
}
},
{
"path":{
"value":"Condition.relatedItem.type"
},
"definition":{
"short":{
"value":"due-to | follows"
},
"formal":{
"value":"The type of relationship that this condition has to the related item."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionRelationshipType"
}
}
},
{
"path":{
"value":"Condition.relatedItem.code"
},
"definition":{
"short":{
"value":"Relationship target by means of a predefined code"
},
"formal":{
"value":"Code that identifies the target of this relationship. The code takes the place of a detailed instance target."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionFinding"
}
}
},
{
"path":{
"value":"Condition.relatedItem.target"
},
"definition":{
"short":{
"value":"Relationship target resource"
},
"formal":{
"value":"Target of the relationship."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Condition|Procedure|Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Condition.notes"
},
"definition":{
"short":{
"value":"Additional information about the Condition"
},
"formal":{
"value":"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NTE child of PRB"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ConditionFinding"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"name":{
"value":"ConditionCategory"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-category"
}
}
},
{
"name":{
"value":"ConditionCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-code"
}
}
},
{
"name":{
"value":"ConditionStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-status"
}
}
},
{
"name":{
"value":"ConditionCertainty"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-certainty"
}
}
},
{
"name":{
"value":"ConditionRelationshipType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-relationship-type"
}
}
},
{
"name":{
"value":"ConditionSeverity"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/condition-severity"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"condition-definitions.htm#Condition\"><b>Condition<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Subject of this condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this condition<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Encounter during which the condition was first asserted.\" class=\"dict\" href=\"condition-definitions.htm#Condition.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Encounter during which the condition was first asserted<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Person who takes responsibility for asserting the existence of the condition as part of the electronic record.\" class=\"dict\" href=\"condition-definitions.htm#Condition.asserter\"><b>asserter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Person who asserts this condition<\/span><span style=\"color: Gray\"> --><\/span></asserter>\r\n <<a title=\"Estimated or actual date the condition/problem/diagnosis was first detected/suspected.\" class=\"dict\" href=\"condition-definitions.htm#Condition.dateAsserted\"><b>dateAsserted<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When first detected/suspected/entered<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identification of the condition, problem or diagnosis.\" class=\"dict\" href=\"condition-definitions.htm#Condition.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.htm\">Identification of the condition, problem or diagnosis<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A category assigned to the condition. E.g. finding | Condition | diagnosis | concern | condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.category\"><b>category<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-category.htm\">E.g. complaint | symptom | finding | diagnosis<\/a><\/span><span style=\"color: Gray\"> --><\/span></category>\r\n <<a title=\"The clinical status of the condition (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.htm#Condition.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-status.htm\">provisional | working | confirmed | refuted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The degree of confidence that this condition is correct (this element modifies the meaning of other elements)\" class=\"dict\" href=\"condition-definitions.htm#Condition.certainty\"><span style=\"text-decoration: underline\"><b>certainty<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-certainty.htm\">Degree of confidence<\/a><\/span><span style=\"color: Gray\"> --><\/span></certainty>\r\n <<a title=\"A subjective assessment of the severity of the condition as evaluated by the clinician.\" class=\"dict\" href=\"condition-definitions.htm#Condition.severity\"><b>severity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-severity.htm\">Subjective severity of condition<\/a><\/span><span style=\"color: Gray\"> --><\/span></severity>\r\n <<a title=\"Estimated or actual date the condition began, in the opinion of the clinician.\" class=\"dict\" href=\"condition-definitions.htm#Condition.onset_x_\"><b>onset[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a><\/span> <span style=\"color: navy\">Estimated or actual date, or age<\/span><span style=\"color: Gray\"> --><\/span></onset[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"condition-definitions.htm#Condition.abatement_x_\"><b>abatement[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a><\/span> <span style=\"color: navy\">If/when in resolution/remission<\/span><span style=\"color: Gray\"> --><\/span></abatement[x]>\r\n <<a title=\"Clinical stage or grade of a condition. May include formal severity assessments.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage\"><b>stage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Stage/grade, usually assessed formally --><\/span>\r\n <<a title=\"A simple summary of the stage such as "Stage 3". The determination of the stage is disease-specific.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage.summary\"><b>summary<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Stage must have summary or assessment\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Simple summary (disease specific)<\/span><span style=\"color: Gray\"> --><\/span></summary>\r\n <<a title=\"Reference to a formal record of the evidence on which the staging assessment is based.\" class=\"dict\" href=\"condition-definitions.htm#Condition.stage.assessment\"><b>assessment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Stage must have summary or assessment\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Formal record of assessment<\/span><span style=\"color: Gray\"> --><\/span></assessment>\r\n </stage>\r\n <<a title=\"Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence\"><b>evidence<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supporting evidence --><\/span>\r\n <<a title=\"A manifestation or symptom that led to the recording of this condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: evidence must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Manifestation/symptom<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Links to other relevant information, including pathology reports.\" class=\"dict\" href=\"condition-definitions.htm#Condition.evidence.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: evidence must have code or details\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Supporting information found elsewhere<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n </evidence>\r\n <<a title=\"The anatomical location where this condition manifests itself.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location\"><b>location<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Anatomical location, if relevant --><\/span>\r\n <<a title=\"Code that identifies the structural location.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: location must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Location - may include laterality<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Detailed anatomical location information.\" class=\"dict\" href=\"condition-definitions.htm#Condition.location.detail\"><b>detail<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: location must have code or details\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Precise location details<\/span><span style=\"color: Gray\"> --><\/span>\r\n </location>\r\n <<a title=\"Further conditions, problems, diagnoses, procedures or events that are related in some way to this condition, or the substance that caused/triggered this Condition.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem\"><b>relatedItem<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Causes or precedents for this Condition --><\/span>\r\n <<a title=\"The type of relationship that this condition has to the related item.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"condition-relationship-type.htm\">due-to | follows<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the target of this relationship. The code takes the place of a detailed instance target.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Relationship must have either a code or a target\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-condition-code.htm\">Relationship target by means of a predefined code<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Target of the relationship.\" class=\"dict\" href=\"condition-definitions.htm#Condition.relatedItem.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Relationship must have either a code or a target\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"condition.htm#Condition\">Condition<\/a>|<a href=\"procedure.htm#Procedure\">Procedure<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Relationship target resource<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </relatedItem>\r\n <<a title=\"Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.\" class=\"dict\" href=\"condition-definitions.htm#Condition.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional information about the Condition<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Condition>\r\n<\/pre><\/div>"
},
{
"title":"\"conformance\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/conformance",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/conformance.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance\"><b>Conformance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name identifying the conformance statement.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Informal name for this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Name of Organization.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Publishing Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contacts for Organization relevant to this conformance statement. May be website, email, phone numbers, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contacts for Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of the conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of this conformance statement (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"conformance-statement-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This conformance statement was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date that the conformance statement is published.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Publication Date<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the software that is covered by this conformance statement. Used when the profile describes the capabilities of a particular software version, independent of an installation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software\"><b>software<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> Software that is covered by this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Name software is known by.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name software is known by<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Version covered by this statement.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version covered by this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date this version of the software released.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.releaseDate\"><b>releaseDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date this version released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n </software>\r\n <<a title=\"Used when the statement describes the capabilities of a specific implementation instance - i.e. a particular installation, rather than the capabilities of a software program.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation\"><b>implementation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> If this describes a specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Information about the specific installation that this conformance statement relates to.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Describes this specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Base URL for the installation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n </implementation>\r\n <<a title=\"The version of the FHIR specification on which this conformance statement is based.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.fhirVersion\"><b>fhirVersion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">FHIR Version<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether the application accepts unknown non-"must understand" elements as part of a resource. This does not include extensions, but genuine new additions to a resource.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.acceptUnknown\"><b>acceptUnknown<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">True if application accepts unknown elements<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The formats supported by this implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.format\"><b>format<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">formats supported (xml | json | mime type)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Defines the restful capabilities of the solution, if any.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest\"><b>rest<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> If the endpoint is a RESTful one --><\/span>\r\n <<a title=\"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-conformance-mode.htm\">client | server<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides documentation about the system's restful capabilities that apply across all applications, such as security.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General description of implementation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about security of implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security\"><b>security<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Information about security of implementation --><\/span>\r\n <<a title=\"What type of security services are supported/required.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.service\"><b>service<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-security-service.htm\">What type of security services are supported/required<\/a><\/span><span style=\"color: Gray\"> --><\/span></service>\r\n <<a title=\"General description of how security works.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General description of how security works<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Certificates associated with security profiles.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate\"><b>certificate<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Certificates associated with security profiles --><\/span>\r\n <<a title=\"Mime type for certificate.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">Mime type for certificate<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Actual certificate.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate.blob\"><b>blob<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual certificate<\/span><span style=\"color: Gray\"> --><\/span>\r\n </certificate>\r\n </security>\r\n <<a title=\"Identifies the restful capabilities of the solution for a specific resource type.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource\"><b>resource<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Resource served on the REST interface --><\/span>\r\n <<a title=\"Identifies the resource exposed via the restful interface.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Resource type<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.profile\"><b>profile<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Resource Profiles supported<\/span><span style=\"color: Gray\"> --><\/span></profile>\r\n <<a title=\"Identifies a restful operation supported by the solution.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation\"><b>operation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> What operations are supported? --><\/span>\r\n <<a title=\"Identifies which operation is supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-operation.htm\">read | vread | update | etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides 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'.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Anything special about operation behavior<\/span><span style=\"color: Gray\"> --><\/span>\r\n </operation>\r\n <<a title=\"A flag for whether the server is able to return past versions as part of the vRead operation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.readHistory\"><b>readHistory<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether vRead can return past versions<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"_include values supported by the server.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchInclude\"><b>searchInclude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">_include values supported by the server<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Defines additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam\"><b>searchParam<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional search params defined --><\/span>\r\n <<a title=\"Corresponds to the name of the standard or custom search parameter.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of search parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.source\"><b>source<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Source of definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.htm\">Type of search parameter<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Contents and meaning of search parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An XPath expression that extracts the set of elements that contain values that a search parameter matches.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.xpath\"><b>xpath<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">XPath that extracts the parameter set<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Types of resource (if a resource reference).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.target\"><b>target<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Types of resource (if a resource reference)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Chained names supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.chain\"><b>chain<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Chained names supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n </searchParam>\r\n </resource>\r\n <<a title=\"If batches are supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.batch\"><b>batch<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If batches are supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If a system wide history list is supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.history\"><b>history<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If a system wide history list is supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query\"><b>query<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Definition of a named query --><\/span>\r\n <<a title=\"The name of this query, which is used in the _query parameter when the query is used.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the query (_query=)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description of the query - the functionality it offers, and considerations about how it functions and to use it.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Describes the named query<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Parameter for the named query.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Conformance.rest.resource.searchParam<\/span> <span style=\"color: navy\">Parameter for the named query<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n </query>\r\n </rest>\r\n <<a title=\"Describes the messaging capabilities of the solution.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging\"><b>messaging<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> If messaging is supported --><\/span>\r\n <<a title=\"The address to which messages and/or replies are to be sent.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual endpoint being described<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The length if the receiver's reliable messaging cache length (if a receiver) or how long the cache length on the receiver should be (if a sender).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.reliableCache\"><b>reliableCache<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reliable Message Cache Length<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides 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.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Messaging interface behavior details<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the solution's support for an event at this end point.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Declare support for this event --><\/span>\r\n <<a title=\"Identifies the supported messaging event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.htm\">Event type<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-conformance-event-mode.htm\">sender | receiver<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the messaging transport protocol(s) supported by this endpoint.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.protocol\"><b>protocol<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-transport.htm\">http | ftp |MLLP | etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span></protocol>\r\n <<a title=\"Identifies the resource associated with the event. This is the resource that defines the event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.focus\"><b>focus<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Resource that's focus of message<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the request for this event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.request\"><b>request<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Profile that describes the request<\/span><span style=\"color: Gray\"> --><\/span></request>\r\n <<a title=\"Information about the response for this event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.response\"><b>response<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Profile that describes the response<\/span><span style=\"color: Gray\"> --><\/span></response>\r\n <<a title=\"Guidance on how this event is handled, such as internal system trigger points, business rules, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Endpoint-specific event documentation<\/span><span style=\"color: Gray\"> --><\/span>\r\n </event>\r\n </messaging>\r\n <<a title=\"A document definition.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document\"><b>document<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Document definition --><\/span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-mode.htm\">producer | consumer<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of document support<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Constraint on a resource used in the document.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.profile\"><b>profile<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Constraint on a resource used in the document<\/span><span style=\"color: Gray\"> --><\/span></profile>\r\n </document>\r\n</Conformance>\r\n<\/pre><\/div>"
},
"name":{
"value":"conformance"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Conformance"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Conformance"
},
"definition":{
"short":{
"value":"A conformance statement"
},
"formal":{
"value":"A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"Details"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must have at least one of description, software, or implementation"
},
"xpath":{
"value":"count(f:software | f:implementation | f:description) > 0"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"Content Required"
},
"severity":{
"value":"error"
},
"human":{
"value":"A Conformance statement must have at least one of rest, messaging or document"
},
"xpath":{
"value":"exists(f:rest) or exists(f:messaging) or exists(f:document)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.identifier"
},
"definition":{
"short":{
"value":"Logical id to reference this statement"
},
"formal":{
"value":"The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.version"
},
"definition":{
"short":{
"value":"Logical id for this version of the statement"
},
"formal":{
"value":"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":{
"value":"There may be multiple resource versions of the conformance statement that have this same identifier."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.name"
},
"definition":{
"short":{
"value":"Informal name for this conformance statement"
},
"formal":{
"value":"A free text natural language name identifying the conformance statement."
},
"comments":{
"value":"Not expected to be globally unique."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.publisher"
},
"definition":{
"short":{
"value":"Publishing Organization"
},
"formal":{
"value":"Name of Organization."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.telecom"
},
"definition":{
"short":{
"value":"Contacts for Organization"
},
"formal":{
"value":"Contacts for Organization relevant to this conformance statement. May be website, email, phone numbers, etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.description"
},
"definition":{
"short":{
"value":"Human description of the conformance statement"
},
"formal":{
"value":"A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP."
},
"comments":{
"value":"This field can be used for things such as why the confomrance statement was written, comments about its context etc. This does not need to be populated when the description is adequately implied by the software or implementation details."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.status"
},
"definition":{
"short":{
"value":"draft | experimental | review | production | withdrawn | superseded"
},
"formal":{
"value":"The status of this conformance statement."
},
"comments":{
"value":"This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ConformanceStatementStatus"
}
}
},
{
"path":{
"value":"Conformance.experimental"
},
"definition":{
"short":{
"value":"If for testing purposes, not real usage"
},
"formal":{
"value":"This conformance statement was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."
},
"comments":{
"value":"Allows filtering of conformance statements that are appropriate for use vs. not."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.date"
},
"definition":{
"short":{
"value":"Publication Date"
},
"formal":{
"value":"Date that the conformance statement is published."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.software"
},
"definition":{
"short":{
"value":"Software that is covered by this conformance statement"
},
"formal":{
"value":"Describes the software that is covered by this conformance statement. Used when the profile describes the capabilities of a particular software version, independent of an installation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.software.name"
},
"definition":{
"short":{
"value":"Name software is known by"
},
"formal":{
"value":"Name software is known by."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.software.version"
},
"definition":{
"short":{
"value":"Version covered by this statement"
},
"formal":{
"value":"Version covered by this statement."
},
"comments":{
"value":"If possible, version should be specified, as statements are likely to be different for different versions of software."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.software.releaseDate"
},
"definition":{
"short":{
"value":"Date this version released"
},
"formal":{
"value":"Date this version of the software released."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.implementation"
},
"definition":{
"short":{
"value":"If this describes a specific instance"
},
"formal":{
"value":"Used when the statement describes the capabilities of a specific implementation instance - i.e. a particular installation, rather than the capabilities of a software program."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.implementation.description"
},
"definition":{
"short":{
"value":"Describes this specific instance"
},
"formal":{
"value":"Information about the specific installation that this conformance statement relates to."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.implementation.url"
},
"definition":{
"short":{
"value":"Base URL for the installation"
},
"formal":{
"value":"The base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.fhirVersion"
},
"definition":{
"short":{
"value":"FHIR Version"
},
"formal":{
"value":"The version of the FHIR specification on which this conformance statement is based."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.acceptUnknown"
},
"definition":{
"short":{
"value":"True if application accepts unknown elements"
},
"formal":{
"value":"Whether the application accepts unknown non-\"must understand\" elements as part of a resource. This does not include extensions, but genuine new additions to a resource."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.format"
},
"definition":{
"short":{
"value":"formats supported (xml | json | mime type)"
},
"formal":{
"value":"The formats supported by this implementation."
},
"comments":{
"value":"\"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":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MimeType"
}
}
},
{
"path":{
"value":"Conformance.rest"
},
"definition":{
"short":{
"value":"If the endpoint is a RESTful one"
},
"formal":{
"value":"Defines the restful capabilities of the solution, if any."
},
"comments":{
"value":"Multiple repetitions allow definition of both client and server behaviors or possibly behaviors under different configuration settings (for software or requirements statements)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.mode"
},
"definition":{
"short":{
"value":"client | server"
},
"formal":{
"value":"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RestfulConformanceMode"
}
}
},
{
"path":{
"value":"Conformance.rest.documentation"
},
"definition":{
"short":{
"value":"General description of implementation"
},
"formal":{
"value":"Provides documentation about the system's restful capabilities that apply across all applications, such as security."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.security"
},
"definition":{
"short":{
"value":"Information about security of implementation"
},
"formal":{
"value":"Information about security of implementation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.security.service"
},
"definition":{
"short":{
"value":"What type of security services are supported/required"
},
"formal":{
"value":"What type of security services are supported/required."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RestfulSecurityService"
}
}
},
{
"path":{
"value":"Conformance.rest.security.description"
},
"definition":{
"short":{
"value":"General description of how security works"
},
"formal":{
"value":"General description of how security works."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.security.certificate"
},
"definition":{
"short":{
"value":"Certificates associated with security profiles"
},
"formal":{
"value":"Certificates associated with security profiles."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.security.certificate.type"
},
"definition":{
"short":{
"value":"Mime type for certificate"
},
"formal":{
"value":"Mime type for certificate."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MimeType"
}
}
},
{
"path":{
"value":"Conformance.rest.security.certificate.blob"
},
"definition":{
"short":{
"value":"Actual certificate"
},
"formal":{
"value":"Actual certificate."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"base64Binary"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource"
},
"definition":{
"short":{
"value":"Resource served on the REST interface"
},
"formal":{
"value":"Identifies the restful capabilities of the solution for a specific resource type."
},
"comments":{
"value":"Max of one repetition per resource type."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.type"
},
"definition":{
"short":{
"value":"Resource type"
},
"formal":{
"value":"Identifies the resource exposed via the restful interface."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ResourceType"
}
}
},
{
"path":{
"value":"Conformance.rest.resource.profile"
},
"definition":{
"short":{
"value":"Resource Profiles supported"
},
"formal":{
"value":"Identifies the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations."
},
"comments":{
"value":"This profile applies to all the resources of this type - i.e. it is the superset of what is supported."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Profile)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.operation"
},
"definition":{
"short":{
"value":"What operations are supported?"
},
"formal":{
"value":"Identifies a restful operation supported by the solution."
},
"comments":{
"value":"The 'search' operation is handled separately."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.operation.code"
},
"definition":{
"short":{
"value":"read | vread | update | etc."
},
"formal":{
"value":"Identifies which operation is supported."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RestfulOperation"
}
}
},
{
"path":{
"value":"Conformance.rest.resource.operation.documentation"
},
"definition":{
"short":{
"value":"Anything special about operation behavior"
},
"formal":{
"value":"Provides 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'."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.readHistory"
},
"definition":{
"short":{
"value":"Whether vRead can return past versions"
},
"formal":{
"value":"A flag for whether the server is able to return past versions as part of the vRead operation."
},
"comments":{
"value":"It is useful to support the vRead operation for current operations, even if past versions aren't available."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchInclude"
},
"definition":{
"short":{
"value":"_include values supported by the server"
},
"formal":{
"value":"_include values supported by the server."
},
"comments":{
"value":"If this list is empty, the server does not support includes."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam"
},
"definition":{
"short":{
"value":"Additional search params defined"
},
"formal":{
"value":"Defines additional search parameters for implementations to support and/or make use of."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.name"
},
"definition":{
"short":{
"value":"Name of search parameter"
},
"formal":{
"value":"Corresponds to the name of the standard or custom search parameter."
},
"comments":{
"value":"Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.source"
},
"definition":{
"short":{
"value":"Source of definition"
},
"formal":{
"value":"A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter."
},
"comments":{
"value":"This SHOULD be populated for all search parameters not defined as custom search extensions. The uri for a search parameter defined in the specification itself is http://hl7.org/fhir/[resource]/search#[name]."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.type"
},
"definition":{
"short":{
"value":"Type of search parameter"
},
"formal":{
"value":"The type of value a search parameter refers to, and how the content is interpreted."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SearchParamType"
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.documentation"
},
"definition":{
"short":{
"value":"Contents and meaning of search parameter"
},
"formal":{
"value":"For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.xpath"
},
"definition":{
"short":{
"value":"XPath that extracts the parameter set"
},
"formal":{
"value":"An XPath expression that extracts the set of elements that contain values that a search parameter matches."
},
"comments":{
"value":"Note that the elements 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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.target"
},
"definition":{
"short":{
"value":"Types of resource (if a resource reference)"
},
"formal":{
"value":"Types of resource (if a resource reference)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ResourceType"
}
}
},
{
"path":{
"value":"Conformance.rest.resource.searchParam.chain"
},
"definition":{
"short":{
"value":"Chained names supported"
},
"formal":{
"value":"Chained names supported."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.batch"
},
"definition":{
"short":{
"value":"If batches are supported"
},
"formal":{
"value":"If batches are supported."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.history"
},
"definition":{
"short":{
"value":"If a system wide history list is supported"
},
"formal":{
"value":"If a system wide history list is supported."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.query"
},
"definition":{
"short":{
"value":"Definition of a named query"
},
"formal":{
"value":"Definition of a named query and its parameters and their meaning."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.query.name"
},
"definition":{
"short":{
"value":"Name of the query (_query=)"
},
"formal":{
"value":"The name of this query, which is used in the _query parameter when the query is used."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.query.documentation"
},
"definition":{
"short":{
"value":"Describes the named query"
},
"formal":{
"value":"Description of the query - the functionality it offers, and considerations about how it functions and to use it."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.rest.query.parameter"
},
"definition":{
"short":{
"value":"Parameter for the named query"
},
"formal":{
"value":"Parameter for the named query."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@Conformance.rest.resource.searchParam"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging"
},
"definition":{
"short":{
"value":"If messaging is supported"
},
"formal":{
"value":"Describes the messaging capabilities of the solution."
},
"comments":{
"value":"Multiple repetitions allow the documentation of multiple endpoints per solution."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"End points for Implementations"
},
"severity":{
"value":"error"
},
"human":{
"value":"Messaging end point is required (and is only permitted) when statement is for an implementation"
},
"xpath":{
"value":"exists(f:endpoint) = exists(parent::f:Conformance/f:implementation)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.endpoint"
},
"definition":{
"short":{
"value":"Actual endpoint being described"
},
"formal":{
"value":"The address to which messages and/or replies are to be sent."
},
"comments":{
"value":"Can be just an identifier for solutions that do not use network addresses for routing."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.reliableCache"
},
"definition":{
"short":{
"value":"Reliable Message Cache Length"
},
"formal":{
"value":"The length if the receiver's reliable messaging cache length (if a receiver) or how long the cache length on the receiver should be (if a sender)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.documentation"
},
"definition":{
"short":{
"value":"Messaging interface behavior details"
},
"formal":{
"value":"Provides 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."
},
"comments":{
"value":"If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.event"
},
"definition":{
"short":{
"value":"Declare support for this event"
},
"formal":{
"value":"Describes the solution's support for an event at this end point."
},
"comments":{
"value":"The same event may be listed up to two times - once as sender and once as receiver."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.event.code"
},
"definition":{
"short":{
"value":"Event type"
},
"formal":{
"value":"Identifies the supported messaging event."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MessageEvent"
}
}
},
{
"path":{
"value":"Conformance.messaging.event.mode"
},
"definition":{
"short":{
"value":"sender | receiver"
},
"formal":{
"value":"The mode of this event declaration - whether application is sender or receiver."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConformanceEventMode"
}
}
},
{
"path":{
"value":"Conformance.messaging.event.protocol"
},
"definition":{
"short":{
"value":"http | ftp |MLLP | etc."
},
"formal":{
"value":"Identifies the messaging transport protocol(s) supported by this endpoint."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MessageTransport"
}
}
},
{
"path":{
"value":"Conformance.messaging.event.focus"
},
"definition":{
"short":{
"value":"Resource that's focus of message"
},
"formal":{
"value":"Identifies the resource associated with the event. This is the resource that defines the event."
},
"comments":{
"value":"This must be provided if the event type supports multiple different resource types."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ResourceType"
}
}
},
{
"path":{
"value":"Conformance.messaging.event.request"
},
"definition":{
"short":{
"value":"Profile that describes the request"
},
"formal":{
"value":"Information about the request for this event."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Profile)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.event.response"
},
"definition":{
"short":{
"value":"Profile that describes the response"
},
"formal":{
"value":"Information about the response for this event."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Profile)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.messaging.event.documentation"
},
"definition":{
"short":{
"value":"Endpoint-specific event documentation"
},
"formal":{
"value":"Guidance on how this event is handled, such as internal system trigger points, business rules, etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.document"
},
"definition":{
"short":{
"value":"Document definition"
},
"formal":{
"value":"A document definition."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.document.mode"
},
"definition":{
"short":{
"value":"producer | consumer"
},
"formal":{
"value":"The mode of this event declaration - whether application is sender or receiver."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentMode"
}
}
},
{
"path":{
"value":"Conformance.document.documentation"
},
"definition":{
"short":{
"value":"Description of document support"
},
"formal":{
"value":"Describes 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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Conformance.document.profile"
},
"definition":{
"short":{
"value":"Constraint on a resource used in the document"
},
"formal":{
"value":"Constraint on a resource used in the document."
},
"comments":{
"value":"The first resource is the document resource."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Profile)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DocumentMode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/document-mode"
}
}
},
{
"name":{
"value":"RestfulOperation"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/restful-operation"
}
}
},
{
"name":{
"value":"MessageTransport"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/message-transport"
}
}
},
{
"name":{
"value":"MessageEvent"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/message-events"
}
}
},
{
"name":{
"value":"RestfulConformanceMode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/restful-conformance-mode"
}
}
},
{
"name":{
"value":"ResourceType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/resource-types"
}
}
},
{
"name":{
"value":"MimeType"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"name":{
"value":"ConformanceEventMode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/message-conformance-event-mode"
}
}
},
{
"name":{
"value":"ConformanceStatementStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/conformance-statement-status"
}
}
},
{
"name":{
"value":"SearchParamType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/search-param-type"
}
}
},
{
"name":{
"value":"RestfulSecurityService"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/restful-security-service"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A conformance statement about how an application or implementation supports FHIR or the set of requirements for a desired implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance\"><b>Conformance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name identifying the conformance statement.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Informal name for this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Name of Organization.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Publishing Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contacts for Organization relevant to this conformance statement. May be website, email, phone numbers, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contacts for Organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the conformance statement and its use. Typically, this is used when the profile describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of the conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of this conformance statement (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"conformance-statement-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This conformance statement was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date that the conformance statement is published.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Publication Date<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the software that is covered by this conformance statement. Used when the profile describes the capabilities of a particular software version, independent of an installation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software\"><b>software<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> Software that is covered by this conformance statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Name software is known by.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name software is known by<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Version covered by this statement.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version covered by this statement<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date this version of the software released.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.software.releaseDate\"><b>releaseDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date this version released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n </software>\r\n <<a title=\"Used when the statement describes the capabilities of a specific implementation instance - i.e. a particular installation, rather than the capabilities of a software program.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation\"><b>implementation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-2: Must have at least one of description, software, or implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> If this describes a specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Information about the specific installation that this conformance statement relates to.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Describes this specific instance<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.implementation.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Base URL for the installation<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n </implementation>\r\n <<a title=\"The version of the FHIR specification on which this conformance statement is based.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.fhirVersion\"><b>fhirVersion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">FHIR Version<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether the application accepts unknown non-"must understand" elements as part of a resource. This does not include extensions, but genuine new additions to a resource.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.acceptUnknown\"><b>acceptUnknown<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">True if application accepts unknown elements<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The formats supported by this implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.format\"><b>format<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">formats supported (xml | json | mime type)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Defines the restful capabilities of the solution, if any.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest\"><b>rest<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> If the endpoint is a RESTful one --><\/span>\r\n <<a title=\"Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-conformance-mode.htm\">client | server<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides documentation about the system's restful capabilities that apply across all applications, such as security.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General description of implementation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about security of implementation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security\"><b>security<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Information about security of implementation --><\/span>\r\n <<a title=\"What type of security services are supported/required.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.service\"><b>service<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-security-service.htm\">What type of security services are supported/required<\/a><\/span><span style=\"color: Gray\"> --><\/span></service>\r\n <<a title=\"General description of how security works.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General description of how security works<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Certificates associated with security profiles.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate\"><b>certificate<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Certificates associated with security profiles --><\/span>\r\n <<a title=\"Mime type for certificate.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">Mime type for certificate<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Actual certificate.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.security.certificate.blob\"><b>blob<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual certificate<\/span><span style=\"color: Gray\"> --><\/span>\r\n </certificate>\r\n </security>\r\n <<a title=\"Identifies the restful capabilities of the solution for a specific resource type.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource\"><b>resource<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Resource served on the REST interface --><\/span>\r\n <<a title=\"Identifies the resource exposed via the restful interface.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Resource type<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the profile that describes the solution's support for the resource, including any constraints on cardinality, bindings, lengths or other limitations.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.profile\"><b>profile<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Resource Profiles supported<\/span><span style=\"color: Gray\"> --><\/span></profile>\r\n <<a title=\"Identifies a restful operation supported by the solution.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation\"><b>operation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> What operations are supported? --><\/span>\r\n <<a title=\"Identifies which operation is supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"restful-operation.htm\">read | vread | update | etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides 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'.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.operation.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Anything special about operation behavior<\/span><span style=\"color: Gray\"> --><\/span>\r\n </operation>\r\n <<a title=\"A flag for whether the server is able to return past versions as part of the vRead operation.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.readHistory\"><b>readHistory<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether vRead can return past versions<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"_include values supported by the server.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchInclude\"><b>searchInclude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">_include values supported by the server<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Defines additional search parameters for implementations to support and/or make use of.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam\"><b>searchParam<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional search params defined --><\/span>\r\n <<a title=\"Corresponds to the name of the standard or custom search parameter.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of search parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.source\"><b>source<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Source of definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of value a search parameter refers to, and how the content is interpreted.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"search-param-type.htm\">Type of search parameter<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Contents and meaning of search parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An XPath expression that extracts the set of elements that contain values that a search parameter matches.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.xpath\"><b>xpath<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">XPath that extracts the parameter set<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Types of resource (if a resource reference).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.target\"><b>target<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Types of resource (if a resource reference)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Chained names supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.resource.searchParam.chain\"><b>chain<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Chained names supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n </searchParam>\r\n </resource>\r\n <<a title=\"If batches are supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.batch\"><b>batch<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If batches are supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If a system wide history list is supported.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.history\"><b>history<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If a system wide history list is supported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Definition of a named query and its parameters and their meaning.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query\"><b>query<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Definition of a named query --><\/span>\r\n <<a title=\"The name of this query, which is used in the _query parameter when the query is used.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the query (_query=)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description of the query - the functionality it offers, and considerations about how it functions and to use it.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Describes the named query<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Parameter for the named query.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.rest.query.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Conformance.rest.resource.searchParam<\/span> <span style=\"color: navy\">Parameter for the named query<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n </query>\r\n </rest>\r\n <<a title=\"Describes the messaging capabilities of the solution.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging\"><b>messaging<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> If messaging is supported --><\/span>\r\n <<a title=\"The address to which messages and/or replies are to be sent.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Messaging end point is required (and is only permitted) when statement is for an implementation\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual endpoint being described<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The length if the receiver's reliable messaging cache length (if a receiver) or how long the cache length on the receiver should be (if a sender).\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.reliableCache\"><b>reliableCache<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reliable Message Cache Length<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides 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.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Messaging interface behavior details<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the solution's support for an event at this end point.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Declare support for this event --><\/span>\r\n <<a title=\"Identifies the supported messaging event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.htm\">Event type<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-conformance-event-mode.htm\">sender | receiver<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the messaging transport protocol(s) supported by this endpoint.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.protocol\"><b>protocol<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-transport.htm\">http | ftp |MLLP | etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span></protocol>\r\n <<a title=\"Identifies the resource associated with the event. This is the resource that defines the event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.focus\"><b>focus<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-types.htm\">Resource that's focus of message<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the request for this event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.request\"><b>request<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Profile that describes the request<\/span><span style=\"color: Gray\"> --><\/span></request>\r\n <<a title=\"Information about the response for this event.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.response\"><b>response<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Profile that describes the response<\/span><span style=\"color: Gray\"> --><\/span></response>\r\n <<a title=\"Guidance on how this event is handled, such as internal system trigger points, business rules, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.messaging.event.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Endpoint-specific event documentation<\/span><span style=\"color: Gray\"> --><\/span>\r\n </event>\r\n </messaging>\r\n <<a title=\"A document definition.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document\"><b>document<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A Conformance statement must have at least one of rest, messaging or document\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Document definition --><\/span>\r\n <<a title=\"The mode of this event declaration - whether application is sender or receiver.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-mode.htm\">producer | consumer<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.documentation\"><b>documentation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of document support<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Constraint on a resource used in the document.\" class=\"dict\" href=\"conformance-definitions.htm#Conformance.document.profile\"><b>profile<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"profile.htm#Profile\">Profile<\/a>)<\/span> <span style=\"color: navy\">Constraint on a resource used in the document<\/span><span style=\"color: Gray\"> --><\/span></profile>\r\n </document>\r\n</Conformance>\r\n<\/pre><\/div>"
},
{
"title":"\"coverage\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/coverage",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/coverage.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Financial instrument by which payment information for health care.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage\"><b>Coverage<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The program or plan underwriter or payor.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.issuer\"><b>issuer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">An identifier for the plan issuer<\/span><span style=\"color: Gray\"> --><\/span></issuer>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Coverage start and end dates<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActCoverageTypeCode.htm\">Type of coverage<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">The primary coverage ID<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Todo.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.plan\"><b>plan<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the plan<\/span><span style=\"color: Gray\"> --><\/span></plan>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subplan\"><b>subplan<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the subsection of the plan<\/span><span style=\"color: Gray\"> --><\/span></subplan>\r\n <<a title=\"A unique identifier for a dependent under the coverage.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.dependent\"><b>dependent<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The dependent number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An optional counter for a particular instance of the identified coverage which increments upon each renewal.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.sequence\"><b>sequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The plan instance or sequence counter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Planholder information.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber\"><b>subscriber<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Planholder information --><\/span>\r\n <<a title=\"The name of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">PolicyHolder name<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The mailing address, typically home, of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">PolicyHolder address<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The date of birth of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.birthdate\"><b>birthdate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">PolicyHolder date of birth<\/span><span style=\"color: Gray\"> --><\/span>\r\n </subscriber>\r\n</Coverage>\r\n<\/pre><\/div>"
},
"name":{
"value":"coverage"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Financial instrument by which payment information for health care."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Coverage"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Coverage"
},
"definition":{
"short":{
"value":"Insurance or medical plan"
},
"formal":{
"value":"Financial instrument by which payment information for health care."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Coverage"
}
}
]
}
},
{
"path":{
"value":"Coverage.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Coverage.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Coverage.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Coverage.issuer"
},
"definition":{
"short":{
"value":"An identifier for the plan issuer"
},
"formal":{
"value":"The program or plan underwriter or payor."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-3-insurance company ID"
}
}
]
}
},
{
"path":{
"value":"Coverage.period"
},
"definition":{
"short":{
"value":"Coverage start and end dates"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-12-plan effective date / IN1-13-plan expiration date"
}
}
]
}
},
{
"path":{
"value":"Coverage.type"
},
"definition":{
"short":{
"value":"Type of coverage"
},
"formal":{
"value":"The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"CoverageType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-15-plan type"
}
}
]
}
},
{
"path":{
"value":"Coverage.identifier"
},
"definition":{
"short":{
"value":"The primary coverage ID"
},
"formal":{
"value":"The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-2-health plan ID"
}
}
]
}
},
{
"path":{
"value":"Coverage.group"
},
"definition":{
"short":{
"value":"An identifier for the group"
},
"formal":{
"value":"Todo."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-8-group number"
}
}
]
}
},
{
"path":{
"value":"Coverage.plan"
},
"definition":{
"short":{
"value":"An identifier for the plan"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-35-company plan code"
}
}
]
}
},
{
"path":{
"value":"Coverage.subplan"
},
"definition":{
"short":{
"value":"An identifier for the subsection of the plan"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-10-insured's group emp ID"
}
}
]
}
},
{
"path":{
"value":"Coverage.dependent"
},
"definition":{
"short":{
"value":"The dependent number"
},
"formal":{
"value":"A unique identifier for a dependent under the coverage."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"- 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 ) )"
}
}
]
}
},
{
"path":{
"value":"Coverage.sequence"
},
"definition":{
"short":{
"value":"The plan instance or sequence counter"
},
"formal":{
"value":"An optional counter for a particular instance of the identified coverage which increments upon each renewal."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No V2.x equivalent concept seems to exist"
}
}
]
}
},
{
"path":{
"value":"Coverage.subscriber"
},
"definition":{
"short":{
"value":"Planholder information"
},
"formal":{
"value":"Planholder information."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Coverage.subscriber.name"
},
"definition":{
"short":{
"value":"PolicyHolder name"
},
"formal":{
"value":"The name of the PolicyHolder."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-16-name of insured"
}
}
]
}
},
{
"path":{
"value":"Coverage.subscriber.address"
},
"definition":{
"short":{
"value":"PolicyHolder address"
},
"formal":{
"value":"The mailing address, typically home, of the PolicyHolder."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-19-insured's address"
}
}
]
}
},
{
"path":{
"value":"Coverage.subscriber.birthdate"
},
"definition":{
"short":{
"value":"PolicyHolder date of birth"
},
"formal":{
"value":"The date of birth of the PolicyHolder."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IN1-18-insured's date of birth"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"CoverageType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/ActCoverageTypeCode"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Financial instrument by which payment information for health care.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage\"><b>Coverage<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The program or plan underwriter or payor.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.issuer\"><b>issuer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">An identifier for the plan issuer<\/span><span style=\"color: Gray\"> --><\/span></issuer>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Coverage start and end dates<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActCoverageTypeCode.htm\">Type of coverage<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The main (and possibly only) identifier for the coverage - often referred to as a Subscriber Id, Certificate number or Personal Health Number or Case ID.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">The primary coverage ID<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Todo.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.plan\"><b>plan<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the plan<\/span><span style=\"color: Gray\"> --><\/span></plan>\r\n <<a title=\"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.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subplan\"><b>subplan<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the subsection of the plan<\/span><span style=\"color: Gray\"> --><\/span></subplan>\r\n <<a title=\"A unique identifier for a dependent under the coverage.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.dependent\"><b>dependent<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The dependent number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An optional counter for a particular instance of the identified coverage which increments upon each renewal.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.sequence\"><b>sequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The plan instance or sequence counter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Planholder information.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber\"><b>subscriber<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Planholder information --><\/span>\r\n <<a title=\"The name of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">PolicyHolder name<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The mailing address, typically home, of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">PolicyHolder address<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The date of birth of the PolicyHolder.\" class=\"dict\" href=\"coverage-definitions.htm#Coverage.subscriber.birthdate\"><b>birthdate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">PolicyHolder date of birth<\/span><span style=\"color: Gray\"> --><\/span>\r\n </subscriber>\r\n</Coverage>\r\n<\/pre><\/div>"
},
{
"title":"\"device\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/device",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/device.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device\"><b>Device<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Describes what kind of device that this.\" class=\"dict\" href=\"device-definitions.htm#Device.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">What kind of device this is<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The name of the manufacturer.\" class=\"dict\" href=\"device-definitions.htm#Device.manufacturer\"><b>manufacturer<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of device manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device.model\"><b>model<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Model id assigned by the manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.\" class=\"dict\" href=\"device-definitions.htm#Device.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version number (i.e. software)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date of expiry of this device (if applicable).\" class=\"dict\" href=\"device-definitions.htm#Device.expiry\"><b>expiry<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date of expiry of this device (if applicable)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Universal Device Id fields.\" class=\"dict\" href=\"device-definitions.htm#Device.identity\"><b>identity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Universal Device Id fields --><\/span>\r\n <<a title=\"The number assigned to this device by an authorised issuer of Device GTINs, based on the standards set by GS1.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.gtin\"><b>gtin<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Global Trade Identification Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Lot number of manufacture.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.lot\"><b>lot<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Lot number of manufacture<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The serial number assigned by the organization when the device was manufactured.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.serialNumber\"><b>serialNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Serial number assigned by the manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n </identity>\r\n <<a title=\"The organization that is responsible for the provision and ongoing maintenance of the device.\" class=\"dict\" href=\"device-definitions.htm#Device.owner\"><b>owner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization responsible for device<\/span><span style=\"color: Gray\"> --><\/span></owner>\r\n <<a title=\"Identifiers assigned to this device by various organizations (unless other specific fields exist for them).\" class=\"dict\" href=\"device-definitions.htm#Device.assignedId\"><b>assignedId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier assigned by various organizations<\/span><span style=\"color: Gray\"> --><\/span></assignedId>\r\n <<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the resource is found<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"If the resource is affixed to a person.\" class=\"dict\" href=\"device-definitions.htm#Device.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">If the resource is affixed to a person<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Contact details for an organization or a particular human that is responsible for the device.\" class=\"dict\" href=\"device-definitions.htm#Device.contact\"><b>contact<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Details for human/organization for support<\/span><span style=\"color: Gray\"> --><\/span></contact>\r\n <<a title=\"A network address on which the device may be contacted directly.\" class=\"dict\" href=\"device-definitions.htm#Device.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Network address to contact device<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Device>\r\n<\/pre><\/div>"
},
"name":{
"value":"device"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Device"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Device"
},
"definition":{
"short":{
"value":"An instance of a manufactured thing that is used in the provision of healthcare"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.type"
},
"definition":{
"short":{
"value":"What kind of device this is"
},
"formal":{
"value":"Describes what kind of device that this."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceKind"
}
}
},
{
"path":{
"value":"Device.manufacturer"
},
"definition":{
"short":{
"value":"Name of device manufacturer"
},
"formal":{
"value":"The name of the manufacturer."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.model"
},
"definition":{
"short":{
"value":"Model id assigned by the manufacturer"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.version"
},
"definition":{
"short":{
"value":"Version number (i.e. software)"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.expiry"
},
"definition":{
"short":{
"value":"Date of expiry of this device (if applicable)"
},
"formal":{
"value":"Date of expiry of this device (if applicable)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.identity"
},
"definition":{
"short":{
"value":"Universal Device Id fields"
},
"formal":{
"value":"Universal Device Id fields."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.identity.gtin"
},
"definition":{
"short":{
"value":"Global Trade Identification Number"
},
"formal":{
"value":"The number assigned to this device by an authorised issuer of Device GTINs, based on the standards set by GS1."
},
"comments":{
"value":"This is a 14 digit number that may include leading 0s."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.identity.lot"
},
"definition":{
"short":{
"value":"Lot number of manufacture"
},
"formal":{
"value":"Lot number of manufacture."
},
"comments":{
"value":"Alphanumeric Maximum 20."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.identity.serialNumber"
},
"definition":{
"short":{
"value":"Serial number assigned by the manufacturer"
},
"formal":{
"value":"The serial number assigned by the organization when the device was manufactured."
},
"comments":{
"value":"Alphanumeric Maximum 20."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.owner"
},
"definition":{
"short":{
"value":"Organization responsible for device"
},
"formal":{
"value":"The organization that is responsible for the provision and ongoing maintenance of the device."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.assignedId"
},
"definition":{
"short":{
"value":"Identifier assigned by various organizations"
},
"formal":{
"value":"Identifiers assigned to this device by various organizations (unless other specific fields exist for them)."
},
"comments":{
"value":"Often fixed to the device as a barcode. May include names given to the device in local usage."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.location"
},
"definition":{
"short":{
"value":"Where the resource is found"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.patient"
},
"definition":{
"short":{
"value":"If the resource is affixed to a person"
},
"formal":{
"value":"If the resource is affixed to a person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.contact"
},
"definition":{
"short":{
"value":"Details for human/organization for support"
},
"formal":{
"value":"Contact details for an organization or a particular human that is responsible for the device."
},
"comments":{
"value":"used for troubleshooting etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Device.url"
},
"definition":{
"short":{
"value":"Network address to contact device"
},
"formal":{
"value":"A network address on which the device may be contacted directly."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DeviceKind"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Defines the nature of the device and the kind of functionality/services/behavior that may be expected from it"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device\"><b>Device<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Describes what kind of device that this.\" class=\"dict\" href=\"device-definitions.htm#Device.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">What kind of device this is<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The name of the manufacturer.\" class=\"dict\" href=\"device-definitions.htm#Device.manufacturer\"><b>manufacturer<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of device manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device.model\"><b>model<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Model id assigned by the manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.\" class=\"dict\" href=\"device-definitions.htm#Device.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version number (i.e. software)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date of expiry of this device (if applicable).\" class=\"dict\" href=\"device-definitions.htm#Device.expiry\"><b>expiry<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date of expiry of this device (if applicable)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Universal Device Id fields.\" class=\"dict\" href=\"device-definitions.htm#Device.identity\"><b>identity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Universal Device Id fields --><\/span>\r\n <<a title=\"The number assigned to this device by an authorised issuer of Device GTINs, based on the standards set by GS1.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.gtin\"><b>gtin<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Global Trade Identification Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Lot number of manufacture.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.lot\"><b>lot<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Lot number of manufacture<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The serial number assigned by the organization when the device was manufactured.\" class=\"dict\" href=\"device-definitions.htm#Device.identity.serialNumber\"><b>serialNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Serial number assigned by the manufacturer<\/span><span style=\"color: Gray\"> --><\/span>\r\n </identity>\r\n <<a title=\"The organization that is responsible for the provision and ongoing maintenance of the device.\" class=\"dict\" href=\"device-definitions.htm#Device.owner\"><b>owner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization responsible for device<\/span><span style=\"color: Gray\"> --><\/span></owner>\r\n <<a title=\"Identifiers assigned to this device by various organizations (unless other specific fields exist for them).\" class=\"dict\" href=\"device-definitions.htm#Device.assignedId\"><b>assignedId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier assigned by various organizations<\/span><span style=\"color: Gray\"> --><\/span></assignedId>\r\n <<a title=\"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.\" class=\"dict\" href=\"device-definitions.htm#Device.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the resource is found<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"If the resource is affixed to a person.\" class=\"dict\" href=\"device-definitions.htm#Device.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">If the resource is affixed to a person<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Contact details for an organization or a particular human that is responsible for the device.\" class=\"dict\" href=\"device-definitions.htm#Device.contact\"><b>contact<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Details for human/organization for support<\/span><span style=\"color: Gray\"> --><\/span></contact>\r\n <<a title=\"A network address on which the device may be contacted directly.\" class=\"dict\" href=\"device-definitions.htm#Device.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Network address to contact device<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Device>\r\n<\/pre><\/div>"
},
{
"title":"\"devicecapabilities\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/devicecapabilities",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/devicecapabilities.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Describes the set of data produced by a device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities\"><b>DeviceCapabilities<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The name of this device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The name of this device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of device - what kind of functionality it provides.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The type of device<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The company that built this device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.manufacturer\"><b>manufacturer<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Company that built the device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies this particular device uniquely.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.identity\"><b>identity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Identifies this particular device uniquely<\/span><span style=\"color: Gray\"> --><\/span></identity>\r\n <<a title=\"A medical-related subsystem of a medical device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice\"><b>virtualDevice<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A medical-related subsystem of a medical device --><\/span>\r\n <<a title=\"Describes the compartment.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the compartment<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Groups together physiological measurement data and derived data.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel\"><b>channel<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Groups related data items --><\/span>\r\n <<a title=\"Describes the channel.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the channel<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A piece of measured or derived data that will be reported by the machine.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric\"><b>metric<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Piece of data reported by device --><\/span>\r\n <<a title=\"Describes the metrics.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the metrics<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Used to link to data in device log.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Used to link to data in device log<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How to interpret this metric value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info\"><b>info<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> How to interpret this metric value --><\/span>\r\n <<a title=\"Type of data for this metric.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: If the type is "Quantity", units must be provided\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"device-data-type.htm\">Quantity | Coding | Array | string<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Units for this data item (if a quantity or a range).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.units\"><b>units<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: If the type is "Quantity", units must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human Readable units of data value<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"UCUM units (if a quantity or a range).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.ucum\"><b>ucum<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: If the type is "Quantity", ucum must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://unitsofmeasure.org.htm\">UCUM units for data value<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A template containing the fixed values for an array output (all the values but the data).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.template\"><b>template<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: If the type is "SampledData", an sampling template must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#SampledData\">SampledData<\/a><\/span> <span style=\"color: navy\">Array template (fixed values)<\/span><span style=\"color: Gray\"> --><\/span></template>\r\n <<a title=\"System of the codes, if the type is a Coding.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: If the type is "Coding', system must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">System for coding<\/span><span style=\"color: Gray\"> --><\/span>\r\n </info>\r\n <<a title=\"Additional data that qualifies the metric, or contributes to its assessment.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet\"><b>facet<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional clarifying or qualifiying data --><\/span>\r\n <<a title=\"Describes the facet.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://loinc.org.htm\">Describes the facet<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The factor to apply to the raw values to get the correct value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.scale\"><b>scale<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Factor to apply to raw values (default = 1)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Used to link to data in device log.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Used to link to data in device log<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How to interpret this facet value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.info\"><b>info<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for DeviceCapabilities.virtualDevice.channel.metric.info<\/span> <span style=\"color: navy\">How to interpret this facet value<\/span><span style=\"color: Gray\"> --><\/span></info>\r\n </facet>\r\n </metric>\r\n </channel>\r\n </virtualDevice>\r\n</DeviceCapabilities>\r\n<\/pre><\/div>"
},
"name":{
"value":"devicecapabilities"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Describes the set of data produced by a device."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DeviceCapabilities"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DeviceCapabilities"
},
"definition":{
"short":{
"value":"Describes the set of data produced by a device"
},
"formal":{
"value":"Describes the set of data produced by a device."
},
"comments":{
"value":"This resource defines what the meanings of the key values are ina device log resource."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.name"
},
"definition":{
"short":{
"value":"The name of this device"
},
"formal":{
"value":"The name of this device."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.type"
},
"definition":{
"short":{
"value":"The type of device"
},
"formal":{
"value":"The kind of device - what kind of functionality it provides."
},
"comments":{
"value":"See Device.type (same codes)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceKind"
}
}
},
{
"path":{
"value":"DeviceCapabilities.manufacturer"
},
"definition":{
"short":{
"value":"Company that built the device"
},
"formal":{
"value":"The company that built this device."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.identity"
},
"definition":{
"short":{
"value":"Identifies this particular device uniquely"
},
"formal":{
"value":"Identifies this particular device uniquely."
},
"comments":{
"value":"Some devices may be configured with identifying information."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice"
},
"definition":{
"short":{
"value":"A medical-related subsystem of a medical device"
},
"formal":{
"value":"A medical-related subsystem of a medical device."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.code"
},
"definition":{
"short":{
"value":"Describes the compartment"
},
"formal":{
"value":"Describes the compartment."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceCompartmentKind"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel"
},
"definition":{
"short":{
"value":"Groups related data items"
},
"formal":{
"value":"Groups together physiological measurement data and derived data."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.code"
},
"definition":{
"short":{
"value":"Describes the channel"
},
"formal":{
"value":"Describes the channel."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceChannelKind"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric"
},
"definition":{
"short":{
"value":"Piece of data reported by device"
},
"formal":{
"value":"A piece of measured or derived data that will be reported by the machine."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.code"
},
"definition":{
"short":{
"value":"Describes the metrics"
},
"formal":{
"value":"Describes the metrics."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceMetricsCode"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.key"
},
"definition":{
"short":{
"value":"Used to link to data in device log"
},
"formal":{
"value":"Used to link to data in device log."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info"
},
"definition":{
"short":{
"value":"How to interpret this metric value"
},
"formal":{
"value":"How to interpret this metric value."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"UCUM rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"If the type is \"Quantity\", ucum must be provided"
},
"xpath":{
"value":"((f:type/@value = 'Quantity') and (f:ucum)) or ((f:type/@value != 'Quantity') and not (f:ucum))"
}
},
{
"key":{
"value":"2"
},
"name":{
"value":"Coding Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"If the type is \"Coding', system must be provided"
},
"xpath":{
"value":"(f:type/@value != 'Coding') or f:system"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"Quantity rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"If the type is \"Quantity\", units must be provided"
},
"xpath":{
"value":"((f:type/@value = 'Quantity') and (f:units)) or (not (f:type/@value != 'Quantity') and not (f:units))"
}
},
{
"key":{
"value":"4"
},
"name":{
"value":"SampleData Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"If the type is \"SampledData\", an sampling template must be provided"
},
"xpath":{
"value":"((f:type/@value = 'SampledData') and (f:template)) or ((f:type/@value != 'SampledData') and not (f:template))"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info.type"
},
"definition":{
"short":{
"value":"Quantity | Coding | Array | string"
},
"formal":{
"value":"Type of data for this metric."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceDataType"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info.units"
},
"definition":{
"short":{
"value":"Human Readable units of data value"
},
"formal":{
"value":"Units for this data item (if a quantity or a range)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info.ucum"
},
"definition":{
"short":{
"value":"UCUM units for data value"
},
"formal":{
"value":"UCUM units (if a quantity or a range)."
},
"comments":{
"value":"Although UCUM units are not required, they are strongly encouraged."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"UCUM"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info.template"
},
"definition":{
"short":{
"value":"Array template (fixed values)"
},
"formal":{
"value":"A template containing the fixed values for an array output (all the values but the data)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"SampledData"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.info.system"
},
"definition":{
"short":{
"value":"System for coding"
},
"formal":{
"value":"System of the codes, if the type is a Coding."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.facet"
},
"definition":{
"short":{
"value":"Additional clarifying or qualifiying data"
},
"formal":{
"value":"Additional data that qualifies the metric, or contributes to its assessment."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.facet.code"
},
"definition":{
"short":{
"value":"Describes the facet"
},
"formal":{
"value":"Describes the facet."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DeviceFacetCode"
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.facet.scale"
},
"definition":{
"short":{
"value":"Factor to apply to raw values (default = 1)"
},
"formal":{
"value":"The factor to apply to the raw values to get the correct value."
},
"comments":{
"value":"The default value is 1."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"decimal"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.facet.key"
},
"definition":{
"short":{
"value":"Used to link to data in device log"
},
"formal":{
"value":"Used to link to data in device log."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceCapabilities.virtualDevice.channel.metric.facet.info"
},
"definition":{
"short":{
"value":"How to interpret this facet value"
},
"formal":{
"value":"How to interpret this facet value."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"@DeviceCapabilities.virtualDevice.channel.metric.info"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DeviceDataType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/device-data-type"
}
}
},
{
"name":{
"value":"DeviceFacetCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceUri":{
"value":"http://loinc.org"
}
},
{
"name":{
"value":"UCUM"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://unitsofmeasure.org"
}
},
{
"name":{
"value":"DeviceMetricsCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Describes the metrics"
}
},
{
"name":{
"value":"DeviceChannelKind"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Describes the channel"
}
},
{
"name":{
"value":"DeviceKind"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Defines the nature of the device and the kind of functionality/services/behavior that may be expected from it"
}
},
{
"name":{
"value":"DeviceCompartmentKind"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Describes the compartment"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Describes the set of data produced by a device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities\"><b>DeviceCapabilities<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The name of this device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The name of this device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of device - what kind of functionality it provides.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The type of device<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The company that built this device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.manufacturer\"><b>manufacturer<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Company that built the device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies this particular device uniquely.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.identity\"><b>identity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Identifies this particular device uniquely<\/span><span style=\"color: Gray\"> --><\/span></identity>\r\n <<a title=\"A medical-related subsystem of a medical device.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice\"><b>virtualDevice<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A medical-related subsystem of a medical device --><\/span>\r\n <<a title=\"Describes the compartment.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the compartment<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Groups together physiological measurement data and derived data.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel\"><b>channel<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Groups related data items --><\/span>\r\n <<a title=\"Describes the channel.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the channel<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A piece of measured or derived data that will be reported by the machine.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric\"><b>metric<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Piece of data reported by device --><\/span>\r\n <<a title=\"Describes the metrics.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Describes the metrics<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Used to link to data in device log.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Used to link to data in device log<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How to interpret this metric value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info\"><b>info<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> How to interpret this metric value --><\/span>\r\n <<a title=\"Type of data for this metric.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: If the type is "Quantity", units must be provided\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"device-data-type.htm\">Quantity | Coding | Array | string<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Units for this data item (if a quantity or a range).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.units\"><b>units<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: If the type is "Quantity", units must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human Readable units of data value<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"UCUM units (if a quantity or a range).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.ucum\"><b>ucum<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: If the type is "Quantity", ucum must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://unitsofmeasure.org.htm\">UCUM units for data value<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A template containing the fixed values for an array output (all the values but the data).\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.template\"><b>template<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: If the type is "SampledData", an sampling template must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#SampledData\">SampledData<\/a><\/span> <span style=\"color: navy\">Array template (fixed values)<\/span><span style=\"color: Gray\"> --><\/span></template>\r\n <<a title=\"System of the codes, if the type is a Coding.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.info.system\"><b>system<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: If the type is "Coding', system must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">System for coding<\/span><span style=\"color: Gray\"> --><\/span>\r\n </info>\r\n <<a title=\"Additional data that qualifies the metric, or contributes to its assessment.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet\"><b>facet<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional clarifying or qualifiying data --><\/span>\r\n <<a title=\"Describes the facet.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://loinc.org.htm\">Describes the facet<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The factor to apply to the raw values to get the correct value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.scale\"><b>scale<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Factor to apply to raw values (default = 1)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Used to link to data in device log.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Used to link to data in device log<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How to interpret this facet value.\" class=\"dict\" href=\"devicecapabilities-definitions.htm#DeviceCapabilities.virtualDevice.channel.metric.facet.info\"><b>info<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for DeviceCapabilities.virtualDevice.channel.metric.info<\/span> <span style=\"color: navy\">How to interpret this facet value<\/span><span style=\"color: Gray\"> --><\/span></info>\r\n </facet>\r\n </metric>\r\n </channel>\r\n </virtualDevice>\r\n</DeviceCapabilities>\r\n<\/pre><\/div>"
},
{
"title":"\"devicelog\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/devicelog",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/devicelog.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A set of raw data produced by a device.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog\"><b>DeviceLog<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The point in time that the values are reported.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.instant\"><b>instant<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the data values are reported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An explicit reference to the capabilities.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.capabilities\"><b>capabilities<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"devicecapabilities.htm#DeviceCapabilities\">DeviceCapabilities<\/a>)<\/span> <span style=\"color: navy\">Explicit reference to the capabilities<\/span><span style=\"color: Gray\"> --><\/span></capabilities>\r\n <<a title=\"The subject of the measurement.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Subject of the measurement<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"An item of data that the device produces.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item\"><b>item<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An item of data --><\/span>\r\n <<a title=\"Reference to a device capabilities declaration.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Reference to device capabilities declaration<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The value of the data item, if available. Irrespective of the logical format of the data item, the value is always represented as a string.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The value of the data item, if available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the quality of the data etc (this element modifies the meaning of other elements)\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.flag\"><span style=\"text-decoration: underline\"><b>flag<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"device-value-flag.htm\">Information about the quality of the data etc<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </item>\r\n</DeviceLog>\r\n<\/pre><\/div>"
},
"name":{
"value":"devicelog"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A set of raw data produced by a device."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DeviceLog"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DeviceLog"
},
"definition":{
"short":{
"value":"A set of raw data produced by a device"
},
"formal":{
"value":"A set of raw data produced by a device."
},
"comments":{
"value":"This resource can only be understood in the context of the DeviceCapabilities that defines what the meanings of the key values are."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.instant"
},
"definition":{
"short":{
"value":"When the data values are reported"
},
"formal":{
"value":"The point in time that the values are reported."
},
"comments":{
"value":"Not all devices have clocks, and so the time may not be included."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.capabilities"
},
"definition":{
"short":{
"value":"Explicit reference to the capabilities"
},
"formal":{
"value":"An explicit reference to the capabilities."
},
"comments":{
"value":"Simple devices may not be in a position to provide an explicit capabilities reference (though even the simplest devices could refer to a capabilities resource on a manufacturer website)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(DeviceCapabilities)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.subject"
},
"definition":{
"short":{
"value":"Subject of the measurement"
},
"formal":{
"value":"The subject of the measurement."
},
"comments":{
"value":"Devices may hold no information about the subject at all, or possibly just an id read from a bar code, with no additional knowledge."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.item"
},
"definition":{
"short":{
"value":"An item of data"
},
"formal":{
"value":"An item of data that the device produces."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.item.key"
},
"definition":{
"short":{
"value":"Reference to device capabilities declaration"
},
"formal":{
"value":"Reference to a device capabilities declaration."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.item.value"
},
"definition":{
"short":{
"value":"The value of the data item, if available"
},
"formal":{
"value":"The value of the data item, if available. Irrespective of the logical format of the data item, the value is always represented as a string."
},
"comments":{
"value":"Usually, either a value or some flags should be provided."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceLog.item.flag"
},
"definition":{
"short":{
"value":"Information about the quality of the data etc"
},
"formal":{
"value":"Information about the quality of the data etc."
},
"comments":{
"value":"Usually, either a value or some flags should be provided."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"DeviceValueFlag"
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DeviceValueFlag"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/device-value-flag"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A set of raw data produced by a device.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog\"><b>DeviceLog<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The point in time that the values are reported.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.instant\"><b>instant<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the data values are reported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An explicit reference to the capabilities.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.capabilities\"><b>capabilities<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"devicecapabilities.htm#DeviceCapabilities\">DeviceCapabilities<\/a>)<\/span> <span style=\"color: navy\">Explicit reference to the capabilities<\/span><span style=\"color: Gray\"> --><\/span></capabilities>\r\n <<a title=\"The subject of the measurement.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Subject of the measurement<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"An item of data that the device produces.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item\"><b>item<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An item of data --><\/span>\r\n <<a title=\"Reference to a device capabilities declaration.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Reference to device capabilities declaration<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The value of the data item, if available. Irrespective of the logical format of the data item, the value is always represented as a string.\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The value of the data item, if available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the quality of the data etc (this element modifies the meaning of other elements)\" class=\"dict\" href=\"devicelog-definitions.htm#DeviceLog.item.flag\"><span style=\"text-decoration: underline\"><b>flag<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"device-value-flag.htm\">Information about the quality of the data etc<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </item>\r\n</DeviceLog>\r\n<\/pre><\/div>"
},
{
"title":"\"deviceobservation\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/deviceobservation",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/deviceobservation.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A set of observations produced by a device.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation\"><b>DeviceObservation<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"A code that identifies what type of device observation this is.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Type of device observation<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifiers assigned to this observation.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifiers assigned to this observation<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Date the measurements were made.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date the measurements were made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the measurements. Usually, but not always, this is a patient. However devices are also used to make measurements on other things as well.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the measurements<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Device that produced the results.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.device\"><b>device<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Device that produced the results<\/span><span style=\"color: Gray\"> --><\/span></device>\r\n <<a title=\"The actual measurements that the device produced.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.measurement\"><b>measurement<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Actual measurements<\/span><span style=\"color: Gray\"> --><\/span></measurement>\r\n</DeviceObservation>\r\n<\/pre><\/div>"
},
"name":{
"value":"deviceobservation"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A set of observations produced by a device."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DeviceObservation"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DeviceObservation"
},
"definition":{
"short":{
"value":"A set of observations produced by a device"
},
"formal":{
"value":"A set of observations produced by a device."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.code"
},
"definition":{
"short":{
"value":"Type of device observation"
},
"formal":{
"value":"A code that identifies what type of device observation this is."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.identifier"
},
"definition":{
"short":{
"value":"Identifiers assigned to this observation"
},
"formal":{
"value":"Identifiers assigned to this observation."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.issued"
},
"definition":{
"short":{
"value":"Date the measurements were made"
},
"formal":{
"value":"Date the measurements were made."
},
"comments":{
"value":"In this context, it is assumed that the issued date is the date that the observations were actually made."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.subject"
},
"definition":{
"short":{
"value":"The subject of the measurements"
},
"formal":{
"value":"The subject of the measurements. Usually, but not always, this is a patient. However devices are also used to make measurements on other things as well."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.device"
},
"definition":{
"short":{
"value":"Device that produced the results"
},
"formal":{
"value":"Device that produced the results."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DeviceObservation.measurement"
},
"definition":{
"short":{
"value":"Actual measurements"
},
"formal":{
"value":"The actual measurements that the device produced."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Observation)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A set of observations produced by a device.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation\"><b>DeviceObservation<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"A code that identifies what type of device observation this is.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Type of device observation<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifiers assigned to this observation.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifiers assigned to this observation<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Date the measurements were made.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date the measurements were made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the measurements. Usually, but not always, this is a patient. However devices are also used to make measurements on other things as well.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the measurements<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Device that produced the results.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.device\"><b>device<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Device that produced the results<\/span><span style=\"color: Gray\"> --><\/span></device>\r\n <<a title=\"The actual measurements that the device produced.\" class=\"dict\" href=\"deviceobservation-definitions.htm#DeviceObservation.measurement\"><b>measurement<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Actual measurements<\/span><span style=\"color: Gray\"> --><\/span></measurement>\r\n</DeviceObservation>\r\n<\/pre><\/div>"
},
{
"title":"\"diagnosticorder\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/diagnosticorder",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/diagnosticorder.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A request for a diagnostic investigation service to be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder\"><b>DiagnosticOrder<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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).\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"location.htm#Location\">Location<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what test is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The practitioner that holds legal responsibility for ordering the investigation.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.orderer\"><b>orderer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who ordered the test<\/span><span style=\"color: Gray\"> --><\/span></orderer>\r\n <<a title=\"Identifiers assigned to this order by the order or by the receiver.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifiers assigned to this order<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"An encounter that provides additional informaton about the healthcare context in which this request is made.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">The encounter that this diagnostic order is associated with<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"An explanation or justification for why this diagnostic investigation is being requested.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.clinicalNotes\"><b>clinicalNotes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Explanation/Justification for test<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"One or more specimens that the diagnostic investigation is about.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">If the whole order relates to specific specimens<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"The status of the order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The clinical priority associated with this order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.priority\"><b>priority<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-priority.htm\">normal | urgent | stat<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A summary of the events of interest that have occurred as the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A list of events of interest in the lifecycle --><\/span>\r\n <<a title=\"The status for the event.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date/time at which the event occurred.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The date at which the event happened<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The person who was responsible for performing or recording the action.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.actor\"><b>actor<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who recorded or did this<\/span><span style=\"color: Gray\"> --><\/span></actor>\r\n </event>\r\n <<a title=\"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.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item\"><b>item<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The items the orderer requested --><\/span>\r\n <<a title=\"A code that identifies a particular diagnostic investigation that has been requested.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.htm\">Code for this item<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"If the item is related to a specific speciment.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">If this item relates to specific specimens<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Location of requested test (if applicable)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"The status of this individual item within the order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A summary of the events of interest that have occurred as this item of the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.event\"><b>event<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for DiagnosticOrder.event<\/span> <span style=\"color: navy\">Events specific to this item<\/span><span style=\"color: Gray\"> --><\/span></event>\r\n </item>\r\n</DiagnosticOrder>\r\n<\/pre><\/div>"
},
"name":{
"value":"diagnosticorder"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A request for a diagnostic investigation service to be performed."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DiagnosticOrder"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DiagnosticOrder"
},
"definition":{
"short":{
"value":"A request for a diagnostic service"
},
"formal":{
"value":"A request for a diagnostic investigation service to be performed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.subject"
},
"definition":{
"short":{
"value":"Who/what test is about"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Location|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.orderer"
},
"definition":{
"short":{
"value":"Who ordered the test"
},
"formal":{
"value":"The practitioner that holds legal responsibility for ordering the investigation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.identifier"
},
"definition":{
"short":{
"value":"Identifiers assigned to this order"
},
"formal":{
"value":"Identifiers assigned to this order by the order or by the receiver."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.encounter"
},
"definition":{
"short":{
"value":"The encounter that this diagnostic order is associated with"
},
"formal":{
"value":"An encounter that provides additional informaton about the healthcare context in which this request is made."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.clinicalNotes"
},
"definition":{
"short":{
"value":"Explanation/Justification for test"
},
"formal":{
"value":"An explanation or justification for why this diagnostic investigation is being requested."
},
"comments":{
"value":"This may be used to decide how the diagnostic investigation will be performed, or even if it will be performed at all."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.specimen"
},
"definition":{
"short":{
"value":"If the whole order relates to specific specimens"
},
"formal":{
"value":"One or more specimens that the diagnostic investigation is about."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Specimen)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.status"
},
"definition":{
"short":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"formal":{
"value":"The status of the order."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticOrderStatus"
}
}
},
{
"path":{
"value":"DiagnosticOrder.priority"
},
"definition":{
"short":{
"value":"normal | urgent | stat"
},
"formal":{
"value":"The clinical priority associated with this order."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticOrderPriority"
}
}
},
{
"path":{
"value":"DiagnosticOrder.event"
},
"definition":{
"short":{
"value":"A list of events of interest in the lifecycle"
},
"formal":{
"value":"A summary of the events of interest that have occurred as the request is processed."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.event.status"
},
"definition":{
"short":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"formal":{
"value":"The status for the event."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticOrderStatus"
}
}
},
{
"path":{
"value":"DiagnosticOrder.event.date"
},
"definition":{
"short":{
"value":"The date at which the event happened"
},
"formal":{
"value":"The date/time at which the event occurred."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.event.actor"
},
"definition":{
"short":{
"value":"Who recorded or did this"
},
"formal":{
"value":"The person who was responsible for performing or recording the action."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.item"
},
"definition":{
"short":{
"value":"The items the orderer requested"
},
"formal":{
"value":"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":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.item.code"
},
"definition":{
"short":{
"value":"Code for this item"
},
"formal":{
"value":"A code that identifies a particular diagnostic investigation that has been requested."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticRequests"
}
}
},
{
"path":{
"value":"DiagnosticOrder.item.specimen"
},
"definition":{
"short":{
"value":"If this item relates to specific specimens"
},
"formal":{
"value":"If the item is related to a specific speciment."
},
"comments":{
"value":"A single specimen should not appear in both DIagnosticOrder.specimen and DiagnosticOrder.item.specimen."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Specimen)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticOrder.item.bodySite"
},
"definition":{
"short":{
"value":"Location of requested test (if applicable)"
},
"formal":{
"value":"Anatomical location where the request test should be performed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BodySite"
}
}
},
{
"path":{
"value":"DiagnosticOrder.item.status"
},
"definition":{
"short":{
"value":"requested | received | accepted | inprogress | review | complete | suspended | rejected | failed"
},
"formal":{
"value":"The status of this individual item within the order."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticOrderStatus"
}
}
},
{
"path":{
"value":"DiagnosticOrder.item.event"
},
"definition":{
"short":{
"value":"Events specific to this item"
},
"formal":{
"value":"A summary of the events of interest that have occurred as this item of the request is processed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@DiagnosticOrder.event"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DiagnosticRequests"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/diagnostic-requests"
}
}
},
{
"name":{
"value":"BodySite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/body-site"
}
}
},
{
"name":{
"value":"DiagnosticOrderStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/diagnostic-order-status"
}
}
},
{
"name":{
"value":"DiagnosticOrderPriority"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/diagnostic-order-priority"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A request for a diagnostic investigation service to be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder\"><b>DiagnosticOrder<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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).\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"location.htm#Location\">Location<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what test is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The practitioner that holds legal responsibility for ordering the investigation.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.orderer\"><b>orderer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who ordered the test<\/span><span style=\"color: Gray\"> --><\/span></orderer>\r\n <<a title=\"Identifiers assigned to this order by the order or by the receiver.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifiers assigned to this order<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"An encounter that provides additional informaton about the healthcare context in which this request is made.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">The encounter that this diagnostic order is associated with<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"An explanation or justification for why this diagnostic investigation is being requested.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.clinicalNotes\"><b>clinicalNotes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Explanation/Justification for test<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"One or more specimens that the diagnostic investigation is about.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">If the whole order relates to specific specimens<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"The status of the order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The clinical priority associated with this order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.priority\"><b>priority<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-priority.htm\">normal | urgent | stat<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A summary of the events of interest that have occurred as the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A list of events of interest in the lifecycle --><\/span>\r\n <<a title=\"The status for the event.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date/time at which the event occurred.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The date at which the event happened<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The person who was responsible for performing or recording the action.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.event.actor\"><b>actor<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who recorded or did this<\/span><span style=\"color: Gray\"> --><\/span></actor>\r\n </event>\r\n <<a title=\"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.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item\"><b>item<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The items the orderer requested --><\/span>\r\n <<a title=\"A code that identifies a particular diagnostic investigation that has been requested.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.htm\">Code for this item<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"If the item is related to a specific speciment.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">If this item relates to specific specimens<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Location of requested test (if applicable)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"The status of this individual item within the order.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"diagnostic-order-status.htm\">requested | received | accepted | inprogress | review | complete | suspended | rejected | failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A summary of the events of interest that have occurred as this item of the request is processed.\" class=\"dict\" href=\"diagnosticorder-definitions.htm#DiagnosticOrder.item.event\"><b>event<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for DiagnosticOrder.event<\/span> <span style=\"color: navy\">Events specific to this item<\/span><span style=\"color: Gray\"> --><\/span></event>\r\n </item>\r\n</DiagnosticOrder>\r\n<\/pre><\/div>"
},
{
"title":"\"diagnosticreport\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/diagnosticreport",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/diagnosticreport.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"The findings and interpretation of diagnostic tests performed on patients and/or specimens. 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.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport\"><b>DiagnosticReport<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The status of the diagnostic report as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">registered|interim|final|amended|cancelled|withdrawn<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date and/or time that this version of the report was released from the source diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date this version was released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The diagnostic service that is responsible for issuing the report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Responsible Diagnostic Service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.reportId\"><b>reportId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id for external references to this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></reportId>\r\n <<a title=\"Details concerning a single pathology test requested.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail\"><b>requestDetail<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> What was requested --><\/span>\r\n <<a title=\"The encounter that this diagnostic investigation is associated with.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Context where request was made<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"The local ID assigned to the order by the order requester.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requestOrderId\"><b>requestOrderId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id assigned by requester<\/span><span style=\"color: Gray\"> --><\/span></requestOrderId>\r\n <<a title=\"The local ID assigned to the test order by the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.receiverOrderId\"><b>receiverOrderId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Receiver's Id for the request<\/span><span style=\"color: Gray\"> --><\/span></receiverOrderId>\r\n <<a title=\"Identification of pathology test requested,.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requestTest\"><b>requestTest<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.htm\">Test Requested<\/a><\/span><span style=\"color: Gray\"> --><\/span></requestTest>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Location of requested test (if applicable)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"Details of the clinician or organization requesting the diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Responsible for request<\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"Details of the clinical information provided to the diagnostic service along with the original request.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.clinicalInfo\"><b>clinicalInfo<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Clinical information provided<\/span><span style=\"color: Gray\"> --><\/span>\r\n </requestDetail>\r\n <<a title=\"The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.serviceCategory\"><b>serviceCategory<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-service-sections.htm\">Biochemistry, Haematology etc.<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></serviceCategory>\r\n <<a title=\"The diagnostically relevant time for this report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.diagnosticTime\"><b>diagnosticTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Effective time of diagnostic report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A group of results. Results may be grouped by specimen, or by some value in DiagnosticReport.resultGroup.name to describe what binds all the results together.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results\"><b>results<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Results grouped by specimen/kind/category --><\/span>\r\n <<a title=\"A code or name that describes this group of results. For the base group, this is the report name.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-report-names.htm\">Name/Code for this group of results<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Details about the individual specimen to which these 'Result group' test results refer.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">Specimen details for this group<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"A sub-group in a report group. Sub groups can be grouped in arbitrary ways. The group.name defines the purpose and interpretation of the grouping.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for DiagnosticReport.results<\/span> <span style=\"color: navy\">Nested Report Group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n <<a title=\"Specific detailed result, including both the value of the result item and additional information that may be useful for clinical interpretation. Results include whatever specific data items pathology labs report as part of the clinical service; it is not confined to measurements.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.result\"><b>result<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">An atomic data result<\/span><span style=\"color: Gray\"> --><\/span></result>\r\n </results>\r\n <<a title=\"A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest).\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.image\"><b>image<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"media.htm#Media\">Media<\/a>|<a href=\"imagingstudy.htm#ImagingStudy\">ImagingStudy<\/a>)<\/span> <span style=\"color: navy\">Key images associated with this report<\/span><span style=\"color: Gray\"> --><\/span></image>\r\n <<a title=\"Concise and clinically contextualised narrative interpretation of the diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.conclusion\"><b>conclusion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Clinical Interpretation of test results<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes for the conclusion.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.codedDiagnosis\"><b>codedDiagnosis<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-clinical-findings.htm\">Codes for the conclusion<\/a><\/span><span style=\"color: Gray\"> --><\/span></codedDiagnosis>\r\n <<a title=\"Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they must be semantically equivalent.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.representation\"><b>representation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Entire Report as issued<\/span><span style=\"color: Gray\"> --><\/span></representation>\r\n</DiagnosticReport>\r\n<\/pre><\/div>"
},
"name":{
"value":"diagnosticreport"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. The findings and interpretation of diagnostic tests performed on patients and/or specimens. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DiagnosticReport"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DiagnosticReport"
},
"definition":{
"short":{
"value":"A Diagnostic report - a combination of request information, atomic results, images, interpretation, and formatted reports"
},
"formal":{
"value":"The findings and interpretation of diagnostic tests performed on patients and/or specimens. 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":{
"value":"This is intended to capture a single report,and is not suitable for use in displaying summary information that covers multiple reports. A typical example is a laboratory cumulative report format."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Observation[isNormalAct() and subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and domainMember(\"LabObservationType\", code)]"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticReport.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticReport.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticReport.status"
},
"definition":{
"short":{
"value":"registered|interim|final|amended|cancelled|withdrawn"
},
"formal":{
"value":"The status of the diagnostic report as a whole."
},
"comments":{
"value":"This is labelled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ObservationStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"registered: ./statusCode[isNormalDatatype()]=\"new\";\n\ninterim: ./statusCode[isNormalDatatype()]=\"active\";\n\nfinal: ./statusCode[isNormalDatatype()]=\"complete\" and not(./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseLabOrder\", code) and isNormalAct()]);\n\namended: ./statusCode[isNormalDatatype()]=\"complete\" and ./inboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#CACT\") and moodCode=\"EVN\" and domainMember(\"ReviseLabOrder\", code) and isNormalAct() and statusCode=\"completed\"];\n\ncancelled: \n./statusCode[isNormalDatatype()]=\"aborted\";\n\nwithdrawn: ./statusCode[isNormalDatatype()]=\"obsolete\""
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-25-Result Status (not 1:1 mapping)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.issued"
},
"definition":{
"short":{
"value":"Date this version was released"
},
"formal":{
"value":"The date and/or time that this version of the report was released from the source diagnostic service."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"firstOf(unique(./participation[isHighest(priorityCode) and typeCode=\"VRF\" and isNormalParticipation()]/time[type=\"TS\"]), \nunique(./participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation()]/time[type=\"TS\"]))"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-22-Results Rpt/Status Chng - Date/Time"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.subject"
},
"definition":{
"short":{
"value":"The subject of the report"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isHighest(priorityCode) and typeCode=\"SBJ\" and isNormalParticipation()]/role[classCode=\"PAT\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List (no V2 mapping for Group or Device)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.performer"
},
"definition":{
"short":{
"value":"Responsible Diagnostic Service"
},
"formal":{
"value":"The diagnostic service that is responsible for issuing the report."
},
"comments":{
"value":"This is not necessarily the source of the atomic data items - it's the entity that takes responsibility for the clinical report."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation()]/role[subsumesCode(\"RoleClass#ASSIGN\", classCode)]/scoper[subsumesCode(\"EntityClass#ORG\", classCode) and determinerCode=\"INSTANCE\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-8-Participation Organization (where this PRT-4-Participation = \"PO\")"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.reportId"
},
"definition":{
"short":{
"value":"Id for external references to this report"
},
"formal":{
"value":"The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-51-Observation Group ID (todo: check semantic intent of OBR-51 with OOWG)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail"
},
"definition":{
"short":{
"value":"What was requested"
},
"formal":{
"value":"Details concerning a single pathology test requested."
},
"comments":{
"value":"Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single Pathology test result resource. Note that there are also cases where one request leads to multiple reports."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./outboundRelationship[typeCode=\"FLFS\" and isNormalActRelationship()]/target[subsumesCode(\"ActClass#OBS\", classCode) and subsumes(\"ActMood#PRMS\", moodCode) and isNormalAct()])"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.encounter"
},
"definition":{
"short":{
"value":"Context where request was made"
},
"formal":{
"value":"The encounter that this diagnostic investigation is associated with."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./inboundRelationship[isHighest(priorityCode) and typeCode=\"SUBJ\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#ENC\", code) and moodCode=\"EVN\" and isNormalAct()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-19-Visit Number"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.requestOrderId"
},
"definition":{
"short":{
"value":"Id assigned by requester"
},
"formal":{
"value":"The local ID assigned to the order by the order requester."
},
"comments":{
"value":"Equivalent to the Placer Order Identifier."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./outboundRelationship[typeCode=\"FLFS\" and isNormalActRelationship()]/target[subsumesCode(\"ActClass#OBS\", classCode) and subsumes(\"ActMood#RQO\", moodCode) and isNormalAct()]/id[scope=\"OBJ\" and displayable=\"true\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-2-Placer Order Number"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.receiverOrderId"
},
"definition":{
"short":{
"value":"Receiver's Id for the request"
},
"formal":{
"value":"The local ID assigned to the test order by the diagnostic service provider."
},
"comments":{
"value":"Usually equivalent to the DICOM Accession Number and the Filler Order Identifier."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./id[scope=\"OBJ\" and displayable=\"true\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-3-Filler Order Number"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.requestTest"
},
"definition":{
"short":{
"value":"Test Requested"
},
"formal":{
"value":"Identification of pathology test requested,."
},
"comments":{
"value":"Useful where the test requested differs from the test actually performed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticRequests"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-4-Universal Service ID"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.bodySite"
},
"definition":{
"short":{
"value":"Location of requested test (if applicable)"
},
"formal":{
"value":"Anatomical location where the request test should be performed."
},
"comments":{
"value":"This is often implicit or explicit in the requested test, and doesn't need to be specified if so."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BodySite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-20-Observation Site (need to distinguish requested site from site actually performed at)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.requester"
},
"definition":{
"short":{
"value":"Responsible for request"
},
"formal":{
"value":"Details of the clinician or organization requesting the diagnostic service."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization|Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Practitioner: unique(./participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation()]/role[subsumesCode(\"RoleClass#ASSIGN\", classCode)]\n\nOrganization: unique(./participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation()]/role[subsumesCode(\"RoleClass#ASSIGN\", classCode)]/scoper[subsumesCode(\"EntityClass#ORG\", classCode) and determinerCode=\"INSTANCE\" and code[isNormalDatatype]])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-16-Ordering Provider"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.requestDetail.clinicalInfo"
},
"definition":{
"short":{
"value":"Clinical information provided"
},
"formal":{
"value":"Details of the clinical information provided to the diagnostic service along with the original request."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"PERT\" and isNormalActRelationship()]/target.text"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-13-Relevant Clinical Information (could also be in NTE-3 or OBR-18, 19, 20, 21)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.serviceCategory"
},
"definition":{
"short":{
"value":"Biochemistry, Haematology etc."
},
"formal":{
"value":"The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticServiceSection"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./inboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#LIST\", classCode) and moodCode=\"EVN\" and inDomain(code,\"Lab Service\") and isNormalAct()]/code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-24-Diagnostic Service Section ID"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.diagnosticTime"
},
"definition":{
"short":{
"value":"Effective time of diagnostic report"
},
"formal":{
"value":"The diagnostically relevant time for this report."
},
"comments":{
"value":"If the diagnostic procedure was performed on the patient, this is the time it was peformed. If there is specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and nor is the exact relationship is not always automatic."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./effectiveTime[type=\"TS\"]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-7-Observation Date/Time"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.results"
},
"definition":{
"short":{
"value":"Results grouped by specimen/kind/category"
},
"formal":{
"value":"A group of results. Results may be grouped by specimen, or by some value in DiagnosticReport.resultGroup.name to describe what binds all the results together."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[isNormalAct() and subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and fromDomain(code, \"LabObservationBattery\")]"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.results.name"
},
"definition":{
"short":{
"value":"Name/Code for this group of results"
},
"formal":{
"value":"A code or name that describes this group of results. For the base group, this is the report name."
},
"comments":{
"value":"Examples of nested report groups: the antibody code for a goup of antibody related test, or the organism code for a group of isolate/sensitivities, or a set of perinatal measurements on a single fetus."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosticResultGroupNames"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR-4-Universal Service ID (V2 doesn't provide an easy way to indicate both the ordered test and the performed panel)"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.results.specimen"
},
"definition":{
"short":{
"value":"Specimen details for this group"
},
"formal":{
"value":"Details about the individual specimen to which these 'Result group' test results refer."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Specimen)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[typeCode=\"SBJ\" and isNormalParticipation()]/role[subsumesCode(\"RoleClass#SPEC\", classCode)])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"SPM"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.results.group"
},
"definition":{
"short":{
"value":"Nested Report Group"
},
"formal":{
"value":"A sub-group in a report group. Sub groups can be grouped in arbitrary ways. The group.name defines the purpose and interpretation of the grouping."
},
"comments":{
"value":"Nested report groups beyond the first level are not used often, but arise in structured pathology reports, and where there is more than one sensitivity assessment per discovered organism."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@DiagnosticReport.results"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DiagnosticReport.results.result"
},
"definition":{
"short":{
"value":"An atomic data result"
},
"formal":{
"value":"Specific detailed result, including both the value of the result item and additional information that may be useful for clinical interpretation. Results include whatever specific data items pathology labs report as part of the clinical service; it is not confined to measurements."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Observation)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and isNormalAct() and fromDomain(code, \"LabObservationResult\")]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.image"
},
"definition":{
"short":{
"value":"Key images associated with this report"
},
"formal":{
"value":"A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest)."
},
"comments":{
"value":"An imaging study is a list of images following a DICOM specification - only list one of these, or multiple images."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Media|ImagingStudy)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX?"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.conclusion"
},
"definition":{
"short":{
"value":"Clinical Interpretation of test results"
},
"formal":{
"value":"Concise and clinically contextualised narrative interpretation of the diagnostic report."
},
"comments":{
"value":"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 narative (e.g. typical imaging report, histopathology)]. In all these cases, the narrative goes in \"text\"."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./inboundRelationship[typeCode=\"SPRT\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and mapsTo(code, \"LOINC#\n48767-8\") and isNormalAct()]/value[type=\"ST\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.codedDiagnosis"
},
"definition":{
"short":{
"value":"Codes for the conclusion"
},
"formal":{
"value":"Codes for the conclusion."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DiagnosisCodes"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./inboundRelationship[typeCode=\"SPRT\" and isNormalActRelationship()]/source[subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and subsumesCode(code, \"LOINC#\n54531-9\") and isNormalAct()]/value[type=\"CD\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX"
}
}
]
}
},
{
"path":{
"value":"DiagnosticReport.representation"
},
"definition":{
"short":{
"value":"Entire Report as issued"
},
"formal":{
"value":"Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they must be semantically equivalent."
},
"comments":{
"value":"Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf, application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.wordprocessingml.document. Application/pdf is recommended as the most reliable and interoperable in this context."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./text[type=\"ED\"]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"DiagnosticRequests"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/diagnostic-requests"
}
}
},
{
"name":{
"value":"BodySite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/body-site"
}
}
},
{
"name":{
"value":"DiagnosisCodes"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/clinical-findings"
}
}
},
{
"name":{
"value":"DiagnosticServiceSection"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/diagnostic-service-sections"
}
}
},
{
"name":{
"value":"DiagnosticResultGroupNames"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/report-names"
}
}
},
{
"name":{
"value":"ObservationStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"The findings and interpretation of diagnostic tests performed on patients and/or specimens. 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.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport\"><b>DiagnosticReport<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The status of the diagnostic report as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">registered|interim|final|amended|cancelled|withdrawn<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date and/or time that this version of the report was released from the source diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date this version was released<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The diagnostic service that is responsible for issuing the report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Responsible Diagnostic Service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.reportId\"><b>reportId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id for external references to this report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></reportId>\r\n <<a title=\"Details concerning a single pathology test requested.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail\"><b>requestDetail<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> What was requested --><\/span>\r\n <<a title=\"The encounter that this diagnostic investigation is associated with.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Context where request was made<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"The local ID assigned to the order by the order requester.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requestOrderId\"><b>requestOrderId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id assigned by requester<\/span><span style=\"color: Gray\"> --><\/span></requestOrderId>\r\n <<a title=\"The local ID assigned to the test order by the diagnostic service provider.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.receiverOrderId\"><b>receiverOrderId<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Receiver's Id for the request<\/span><span style=\"color: Gray\"> --><\/span></receiverOrderId>\r\n <<a title=\"Identification of pathology test requested,.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requestTest\"><b>requestTest<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-requests.htm\">Test Requested<\/a><\/span><span style=\"color: Gray\"> --><\/span></requestTest>\r\n <<a title=\"Anatomical location where the request test should be performed.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Location of requested test (if applicable)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"Details of the clinician or organization requesting the diagnostic service.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Responsible for request<\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"Details of the clinical information provided to the diagnostic service along with the original request.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.requestDetail.clinicalInfo\"><b>clinicalInfo<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Clinical information provided<\/span><span style=\"color: Gray\"> --><\/span>\r\n </requestDetail>\r\n <<a title=\"The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.serviceCategory\"><b>serviceCategory<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-diagnostic-service-sections.htm\">Biochemistry, Haematology etc.<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></serviceCategory>\r\n <<a title=\"The diagnostically relevant time for this report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.diagnosticTime\"><b>diagnosticTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Effective time of diagnostic report<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A group of results. Results may be grouped by specimen, or by some value in DiagnosticReport.resultGroup.name to describe what binds all the results together.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results\"><b>results<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Results grouped by specimen/kind/category --><\/span>\r\n <<a title=\"A code or name that describes this group of results. For the base group, this is the report name.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-report-names.htm\">Name/Code for this group of results<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Details about the individual specimen to which these 'Result group' test results refer.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.specimen\"><b>specimen<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">Specimen details for this group<\/span><span style=\"color: Gray\"> --><\/span></specimen>\r\n <<a title=\"A sub-group in a report group. Sub groups can be grouped in arbitrary ways. The group.name defines the purpose and interpretation of the grouping.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for DiagnosticReport.results<\/span> <span style=\"color: navy\">Nested Report Group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n <<a title=\"Specific detailed result, including both the value of the result item and additional information that may be useful for clinical interpretation. Results include whatever specific data items pathology labs report as part of the clinical service; it is not confined to measurements.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.results.result\"><b>result<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">An atomic data result<\/span><span style=\"color: Gray\"> --><\/span></result>\r\n </results>\r\n <<a title=\"A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest).\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.image\"><b>image<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"media.htm#Media\">Media<\/a>|<a href=\"imagingstudy.htm#ImagingStudy\">ImagingStudy<\/a>)<\/span> <span style=\"color: navy\">Key images associated with this report<\/span><span style=\"color: Gray\"> --><\/span></image>\r\n <<a title=\"Concise and clinically contextualised narrative interpretation of the diagnostic report.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.conclusion\"><b>conclusion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Clinical Interpretation of test results<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Codes for the conclusion.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.codedDiagnosis\"><b>codedDiagnosis<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-clinical-findings.htm\">Codes for the conclusion<\/a><\/span><span style=\"color: Gray\"> --><\/span></codedDiagnosis>\r\n <<a title=\"Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they must be semantically equivalent.\" class=\"dict\" href=\"diagnosticreport-definitions.htm#DiagnosticReport.representation\"><b>representation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Entire Report as issued<\/span><span style=\"color: Gray\"> --><\/span></representation>\r\n</DiagnosticReport>\r\n<\/pre><\/div>"
},
{
"title":"\"document\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/document",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/document.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed.\" class=\"dict\" href=\"document-definitions.htm#Document\"><b>Document<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Logical Identifier for the document, assigned when created. This identifier stays constant when subsequent versions of the document are created.\" class=\"dict\" href=\"document-definitions.htm#Document.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Logical identifier for document (version-independent)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Version specific identifier for the document, assigned when created. This identifier changes when subsequent versions of the document are created.\" class=\"dict\" href=\"document-definitions.htm#Document.versionIdentifier\"><b>versionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Version-specific identifier for document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></versionIdentifier>\r\n <<a title=\"The document creation time, when the document first came into being. Where the document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created.\" class=\"dict\" href=\"document-definitions.htm#Document.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Document creation time<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).\" class=\"dict\" href=\"document-definitions.htm#Document.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.htm\">Kind of document (LOINC if possible)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Additional detailed type for the document.\" class=\"dict\" href=\"document-definitions.htm#Document.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.htm\">More detail about the document type<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Official human-readable label for the document.\" class=\"dict\" href=\"document-definitions.htm#Document.title\"><b>title<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Document title<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The workflow/clinical status of this document. The status is a rough guide to the clinical standing of the document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-status.htm\">Status of this document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The code specifying the level of confidentiality of the XDS Document. These codes are specific to an XDS Affinity Domain (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-confidentiality.htm\">As defined by affinity domain<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></confidentiality>\r\n <<a title=\"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).\" class=\"dict\" href=\"document-definitions.htm#Document.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what the document is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Identifies who is responsible for the information in the document. (Not necessarily who typed it in.).\" class=\"dict\" href=\"document-definitions.htm#Document.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what authored the final document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"A participant who has attested to the accuracy of the document.\" class=\"dict\" href=\"document-definitions.htm#Document.attester\"><b>attester<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Attests to accuracy of document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"The type of attestation the authenticator offers.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-attestation-mode.htm\">personal | professional | legal | official<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When document was attested by the party.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.time\"><b>time<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When document attested<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who attested the document in the specified way.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.party\"><b>party<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who attested the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></party>\r\n </attester>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"document-definitions.htm#Document.custodian\"><b>custodian<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Org which maintains the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></custodian>\r\n <<a title=\"The main event/act/item, such as a colonoscopy or an appendectomy, being documented.\" class=\"dict\" href=\"document-definitions.htm#Document.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> The clinical event/act/item being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"document-definitions.htm#Document.event.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-event-code.htm\">Code(s) that apply to the event being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The period of time covered by the document. There is no assertion that the document is a complete representation for this period, only that it documents events during this time.\" class=\"dict\" href=\"document-definitions.htm#Document.event.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The period covered by the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Full details for the event(s) the document concents.\" class=\"dict\" href=\"document-definitions.htm#Document.event.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Full details for the event(s) the document concents<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n </event>\r\n <<a title=\"Describes the clinical encounter or type of care this document is associated with.\" class=\"dict\" href=\"document-definitions.htm#Document.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>|<a title=\"This resource has not been defined yet\">InterestOfCare<\/a>)<\/span> <span style=\"color: navy\">Context of the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Identifies the document this document supersedes, if any (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.replaces\"><span style=\"text-decoration: underline\"><b>replaces<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this document replaces another<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional provenance about the document and the resources that are the sections.\" class=\"dict\" href=\"document-definitions.htm#Document.provenance\"><b>provenance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"provenance.htm#Provenance\">Provenance<\/a>)<\/span> <span style=\"color: navy\">Additional provenance about the document and its parts<\/span><span style=\"color: Gray\"> --><\/span></provenance>\r\n <<a title=\"A fixed CSS stylesheet to use when rendering the documents.\" class=\"dict\" href=\"document-definitions.htm#Document.stylesheet\"><b>stylesheet<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: A document stylesheet must have a mime type of text/css\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Stylesheet to use when rendering the document<\/span><span style=\"color: Gray\"> --><\/span></stylesheet>\r\n <<a title=\"An alternative representation of the document that can be used in place of the html based rendering.\" class=\"dict\" href=\"document-definitions.htm#Document.representation\"><b>representation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: A document must have a representation, one or more sections or both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Alternative representation of the document<\/span><span style=\"color: Gray\"> --><\/span></representation>\r\n <<a title=\"Identifies a main topic within the document's table of contents.\" class=\"dict\" href=\"document-definitions.htm#Document.section\"><b>section<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: A document must have a representation, one or more sections or both\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Document is broken into sections --><\/span>\r\n <<a title=\"A code identifying the kind of content contained within the section.\" class=\"dict\" href=\"document-definitions.htm#Document.section.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-section-codes.htm\">Classification of section (recommended)<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies the primary subject of the section (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.section.subject\"><span style=\"text-decoration: underline\"><b>subject<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">If section different to document<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Identifies the discrete data that provides the content for the section.\" class=\"dict\" href=\"document-definitions.htm#Document.section.content\"><b>content<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A section must have content or one or more sections, but not both.\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The actual data for the section<\/span><span style=\"color: Gray\"> --><\/span></content>\r\n <<a title=\"Identifies a subtopic within the section as part of the document's table of contents.\" class=\"dict\" href=\"document-definitions.htm#Document.section.section\"><b>section<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A section must have content or one or more sections, but not both.\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Document.section<\/span> <span style=\"color: navy\">Nested Section<\/span><span style=\"color: Gray\"> --><\/span></section>\r\n </section>\r\n</Document>\r\n<\/pre><\/div>"
},
"name":{
"value":"document"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Document"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Document"
},
"definition":{
"short":{
"value":"A document that contains resources"
},
"formal":{
"value":"A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed."
},
"comments":{
"value":"While the focus of this specification is on patient-specific clinical documents, this resource can also apply to other healthcare-related documents such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"Document Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"A document must have a representation, one or more sections or both"
},
"xpath":{
"value":"exists(f:representation) or exists(f:section)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Document[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct()]"
}
}
]
}
},
{
"path":{
"value":"Document.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.identifier"
},
"definition":{
"short":{
"value":"Logical identifier for document (version-independent)"
},
"formal":{
"value":"Logical Identifier for the document, assigned when created. This identifier stays constant when subsequent versions of the document are created."
},
"comments":{
"value":"see discussion in resource definition for how these relate."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Document.id / Document.setId"
}
}
]
}
},
{
"path":{
"value":"Document.versionIdentifier"
},
"definition":{
"short":{
"value":"Version-specific identifier for document"
},
"formal":{
"value":"Version specific identifier for the document, assigned when created. This identifier changes when subsequent versions of the document are created."
},
"comments":{
"value":"see discussion in resource definition for how these relate."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Document.id"
}
}
]
}
},
{
"path":{
"value":"Document.created"
},
"definition":{
"short":{
"value":"Document creation time"
},
"formal":{
"value":"The document creation time, when the document first came into being. Where the document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./effectiveTime[type=\"TS\"]"
}
}
]
}
},
{
"path":{
"value":"Document.type"
},
"definition":{
"short":{
"value":"Kind of document (LOINC if possible)"
},
"formal":{
"value":"Specifies the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Document.subtype"
},
"definition":{
"short":{
"value":"More detail about the document type"
},
"formal":{
"value":"Additional detailed type for the document."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentSubType"
}
}
},
{
"path":{
"value":"Document.title"
},
"definition":{
"short":{
"value":"Document title"
},
"formal":{
"value":"Official human-readable label for the document."
},
"comments":{
"value":"It's commonly the case that clinical documents do not have a title and are collectively referred to by the display name of Document.type (e.g. a \"consultation\" or \"progress note\"). Where these display names are rendered to the clinician or where the document has a unique title, the Document.title value should be used."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./title"
}
}
]
}
},
{
"path":{
"value":"Document.status"
},
"definition":{
"short":{
"value":"Status of this document"
},
"formal":{
"value":"The workflow/clinical status of this document. The status is a rough guide to the clinical standing of the document."
},
"comments":{
"value":"A document marked as an amendment SHOULD replace another document. However the amended flag is not the same as a replacement statement - the amendment flag is looser, and indicates that other related documents about the same thing have been released in *some* context prior to the release of this document. \n\nIf a document is marked as withdrawn, the document, or data from the document, should never be displayed to a user without being clearly marked as untrustworthy. The flag \"withdrawn\" is why this element is labelled as a modifier of other elements."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"DocumentStatus"
}
}
},
{
"path":{
"value":"Document.confidentiality"
},
"definition":{
"short":{
"value":"As defined by affinity domain"
},
"formal":{
"value":"The code specifying the level of confidentiality of the XDS Document. These codes are specific to an XDS Affinity Domain."
},
"comments":{
"value":"Enforcement and issues related to highly sensitive documents are beyond the scope of XDS (see security section). confidentialityCode is part of a codification scheme and value set enforced by the Document Registry."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"DocumentConfidentiality"
}
}
},
{
"path":{
"value":"Document.subject"
},
"definition":{
"short":{
"value":"Who/what the document is about"
},
"formal":{
"value":"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)."
},
"comments":{
"value":"For clinical documents, this is usually the patient."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"PAT\"])\nor\nunique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"IDENT\"]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"ORG\") and isNormalEntity()])"
}
}
]
}
},
{
"path":{
"value":"Document.author"
},
"definition":{
"short":{
"value":"Who/what authored the final document"
},
"formal":{
"value":"Identifies who is responsible for the information in the document. (Not necessarily who typed it in.)."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]"
}
}
]
}
},
{
"path":{
"value":"Document.attester"
},
"definition":{
"short":{
"value":"Attests to accuracy of document"
},
"formal":{
"value":"A participant who has attested to the accuracy of the document."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode=\"AUTHEN\" and isNormalParticipation]"
}
}
]
}
},
{
"path":{
"value":"Document.attester.mode"
},
"definition":{
"short":{
"value":"personal | professional | legal | official"
},
"formal":{
"value":"The type of attestation the authenticator offers."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentAttestationMode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./modeCode)"
}
}
]
}
},
{
"path":{
"value":"Document.attester.time"
},
"definition":{
"short":{
"value":"When document attested"
},
"formal":{
"value":"When document was attested by the party."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./time[type=\"TS\" and isNormalDatatype()]"
}
}
]
}
},
{
"path":{
"value":"Document.attester.party"
},
"definition":{
"short":{
"value":"Who attested the document"
},
"formal":{
"value":"Who attested the document in the specified way."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./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":{
"value":"Document.custodian"
},
"definition":{
"short":{
"value":"Org which maintains the document"
},
"formal":{
"value":"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode=\"RCV\" and isNormalParticipation]/role[classCode=\"CUST\" and isNormalRole and not (player)]/scoper[classCode=\"ORG\" and determinerCode=\"INST\" and isNormalEntity()]"
}
}
]
}
},
{
"path":{
"value":"Document.event"
},
"definition":{
"short":{
"value":"The clinical event/act/item being documented"
},
"formal":{
"value":"The main event/act/item, such as a colonoscopy or an appendectomy, being documented."
},
"comments":{
"value":"The event needs to be consistent with the type element, though can provide further information if desired."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and isNormalAct])"
}
}
]
}
},
{
"path":{
"value":"Document.event.code"
},
"definition":{
"short":{
"value":"Code(s) that apply to the event being documented"
},
"formal":{
"value":"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":{
"value":"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 \u201ckey words\u201d for certain types of queries."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentEventCode"
}
}
},
{
"path":{
"value":"Document.event.period"
},
"definition":{
"short":{
"value":"The period covered by the document"
},
"formal":{
"value":"The period of time covered by the document. There is no assertion that the document is a complete representation for this period, only that it documents events during this time."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.event.detail"
},
"definition":{
"short":{
"value":"Full details for the event(s) the document concents"
},
"formal":{
"value":"Full details for the event(s) the document concents."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.encounter"
},
"definition":{
"short":{
"value":"Context of the document"
},
"formal":{
"value":"Describes the clinical encounter or type of care this document is associated with."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter|InterestOfCare)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(highest(./outboundRelationship[typeCode=\"SUBJ\" and isNormalActRelationship()], priorityNumber)/target[moodCode=\"EVN\" and classCode=(\"ENC\", \"PCPR\") and isNormalAct])"
}
}
]
}
},
{
"path":{
"value":"Document.replaces"
},
"definition":{
"short":{
"value":"If this document replaces another"
},
"formal":{
"value":"Identifies the document this document supersedes, if any."
},
"comments":{
"value":"This is labelled as \"Is Modifier\" because applications must be aware of document replacement semantics and behave appropriately."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(highest(./outboundRelationship[typeCode=\"RPLC and isNormalActRelationship()], priorityNumber)/target[classCode=\"DOC\" and moodCode=\"EVN\" and isNormalAct]/id[isNormalDatatype() and displayable=\"false\" and scope=\"OBJ\" and reliability=\"ISS\"])"
}
}
]
}
},
{
"path":{
"value":"Document.provenance"
},
"definition":{
"short":{
"value":"Additional provenance about the document and its parts"
},
"formal":{
"value":"Additional provenance about the document and the resources that are the sections."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Provenance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.stylesheet"
},
"definition":{
"short":{
"value":"Stylesheet to use when rendering the document"
},
"formal":{
"value":"A fixed CSS stylesheet to use when rendering the documents."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"4"
},
"name":{
"value":"Stylesheet Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"A document stylesheet must have a mime type of text/css"
},
"xpath":{
"value":"f:mimeType/@value = 'text/css'"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"Document.representation"
},
"definition":{
"short":{
"value":"Alternative representation of the document"
},
"formal":{
"value":"An alternative representation of the document that can be used in place of the html based rendering."
},
"comments":{
"value":"Typically, this is application/pdf."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Document.section"
},
"definition":{
"short":{
"value":"Document is broken into sections"
},
"formal":{
"value":"Identifies a main topic within the document's table of contents."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"Section Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"A section must have content or one or more sections, but not both."
},
"xpath":{
"value":"exists(f:content) != exists(f:section)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
}
]
}
},
{
"path":{
"value":"Document.section.code"
},
"definition":{
"short":{
"value":"Classification of section (recommended)"
},
"formal":{
"value":"A code identifying the kind of content contained within the section."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentSectionCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Document.section.subject"
},
"definition":{
"short":{
"value":"If section different to document"
},
"formal":{
"value":"Identifies the primary subject of the section."
},
"comments":{
"value":"This is labelled as \"Is Modifier\" because applications must be aware if the subject changes for a particular section."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"PAT\"])\nor\nunique(./participation[typeCode=\"SBJ\" and isNormalParticipation]/role[typeCode=\"IDENT\"]/player[determinerCode=\"INST\" and classCode=(\"DEV\", \"ORG\") and isNormalEntity()])"
}
}
]
}
},
{
"path":{
"value":"Document.section.content"
},
"definition":{
"short":{
"value":"The actual data for the section"
},
"formal":{
"value":"Identifies the discrete data that provides the content for the section."
},
"comments":{
"value":"Because documents represent point-in-time snapshots, resource references should generally be to a specific version."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode!=\"DOCSECT\" and isNormalAct])"
}
}
]
}
},
{
"path":{
"value":"Document.section.section"
},
"definition":{
"short":{
"value":"Nested Section"
},
"formal":{
"value":"Identifies a subtopic within the section as part of the document's table of contents."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@Document.section"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[moodCode=\"EVN\" and classCode=\"DOCSECT\" and isNormalAct]"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"DocumentAttestationMode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/document-attestation-mode"
}
}
},
{
"name":{
"value":"DocumentSubType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/xds-typecodes"
}
}
},
{
"name":{
"value":"DocumentSectionCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-section-codes"
}
}
},
{
"name":{
"value":"DocumentStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/document-status"
}
}
},
{
"name":{
"value":"DocumentEventCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-event-code"
}
}
},
{
"name":{
"value":"DocumentConfidentiality"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-confidentiality"
}
}
},
{
"name":{
"value":"DocumentType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-codes"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A documentation of healthcare-related information that is assembled together into a single statement of meaning that establishes its own context. A document is composed of a set of resources that include both human and computer readable portions. A human may attest to the accuracy of the human readable portion and may authenticate and/or sign the entire whole. A document may be kept as a set of logically linked resources, or they may be bundled together in an atom feed.\" class=\"dict\" href=\"document-definitions.htm#Document\"><b>Document<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Logical Identifier for the document, assigned when created. This identifier stays constant when subsequent versions of the document are created.\" class=\"dict\" href=\"document-definitions.htm#Document.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Logical identifier for document (version-independent)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Version specific identifier for the document, assigned when created. This identifier changes when subsequent versions of the document are created.\" class=\"dict\" href=\"document-definitions.htm#Document.versionIdentifier\"><b>versionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Version-specific identifier for document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></versionIdentifier>\r\n <<a title=\"The document creation time, when the document first came into being. Where the document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created.\" class=\"dict\" href=\"document-definitions.htm#Document.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Document creation time<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note).\" class=\"dict\" href=\"document-definitions.htm#Document.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.htm\">Kind of document (LOINC if possible)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Additional detailed type for the document.\" class=\"dict\" href=\"document-definitions.htm#Document.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.htm\">More detail about the document type<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Official human-readable label for the document.\" class=\"dict\" href=\"document-definitions.htm#Document.title\"><b>title<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Document title<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The workflow/clinical status of this document. The status is a rough guide to the clinical standing of the document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-status.htm\">Status of this document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The code specifying the level of confidentiality of the XDS Document. These codes are specific to an XDS Affinity Domain (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-confidentiality.htm\">As defined by affinity domain<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></confidentiality>\r\n <<a title=\"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).\" class=\"dict\" href=\"document-definitions.htm#Document.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what the document is about<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Identifies who is responsible for the information in the document. (Not necessarily who typed it in.).\" class=\"dict\" href=\"document-definitions.htm#Document.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what authored the final document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"A participant who has attested to the accuracy of the document.\" class=\"dict\" href=\"document-definitions.htm#Document.attester\"><b>attester<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Attests to accuracy of document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"The type of attestation the authenticator offers.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.mode\"><b>mode<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-attestation-mode.htm\">personal | professional | legal | official<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When document was attested by the party.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.time\"><b>time<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When document attested<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who attested the document in the specified way.\" class=\"dict\" href=\"document-definitions.htm#Document.attester.party\"><b>party<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who attested the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></party>\r\n </attester>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"document-definitions.htm#Document.custodian\"><b>custodian<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Org which maintains the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></custodian>\r\n <<a title=\"The main event/act/item, such as a colonoscopy or an appendectomy, being documented.\" class=\"dict\" href=\"document-definitions.htm#Document.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> The clinical event/act/item being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"document-definitions.htm#Document.event.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-event-code.htm\">Code(s) that apply to the event being documented<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The period of time covered by the document. There is no assertion that the document is a complete representation for this period, only that it documents events during this time.\" class=\"dict\" href=\"document-definitions.htm#Document.event.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The period covered by the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Full details for the event(s) the document concents.\" class=\"dict\" href=\"document-definitions.htm#Document.event.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Full details for the event(s) the document concents<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n </event>\r\n <<a title=\"Describes the clinical encounter or type of care this document is associated with.\" class=\"dict\" href=\"document-definitions.htm#Document.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>|<a title=\"This resource has not been defined yet\">InterestOfCare<\/a>)<\/span> <span style=\"color: navy\">Context of the document<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Identifies the document this document supersedes, if any (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.replaces\"><span style=\"text-decoration: underline\"><b>replaces<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this document replaces another<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional provenance about the document and the resources that are the sections.\" class=\"dict\" href=\"document-definitions.htm#Document.provenance\"><b>provenance<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"provenance.htm#Provenance\">Provenance<\/a>)<\/span> <span style=\"color: navy\">Additional provenance about the document and its parts<\/span><span style=\"color: Gray\"> --><\/span></provenance>\r\n <<a title=\"A fixed CSS stylesheet to use when rendering the documents.\" class=\"dict\" href=\"document-definitions.htm#Document.stylesheet\"><b>stylesheet<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: A document stylesheet must have a mime type of text/css\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Stylesheet to use when rendering the document<\/span><span style=\"color: Gray\"> --><\/span></stylesheet>\r\n <<a title=\"An alternative representation of the document that can be used in place of the html based rendering.\" class=\"dict\" href=\"document-definitions.htm#Document.representation\"><b>representation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: A document must have a representation, one or more sections or both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Alternative representation of the document<\/span><span style=\"color: Gray\"> --><\/span></representation>\r\n <<a title=\"Identifies a main topic within the document's table of contents.\" class=\"dict\" href=\"document-definitions.htm#Document.section\"><b>section<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-3: A document must have a representation, one or more sections or both\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Document is broken into sections --><\/span>\r\n <<a title=\"A code identifying the kind of content contained within the section.\" class=\"dict\" href=\"document-definitions.htm#Document.section.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-section-codes.htm\">Classification of section (recommended)<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies the primary subject of the section (this element modifies the meaning of other elements)\" class=\"dict\" href=\"document-definitions.htm#Document.section.subject\"><span style=\"text-decoration: underline\"><b>subject<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">If section different to document<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Identifies the discrete data that provides the content for the section.\" class=\"dict\" href=\"document-definitions.htm#Document.section.content\"><b>content<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A section must have content or one or more sections, but not both.\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The actual data for the section<\/span><span style=\"color: Gray\"> --><\/span></content>\r\n <<a title=\"Identifies a subtopic within the section as part of the document's table of contents.\" class=\"dict\" href=\"document-definitions.htm#Document.section.section\"><b>section<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: A section must have content or one or more sections, but not both.\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Document.section<\/span> <span style=\"color: navy\">Nested Section<\/span><span style=\"color: Gray\"> --><\/span></section>\r\n </section>\r\n</Document>\r\n<\/pre><\/div>"
},
{
"title":"\"documentreference\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/documentreference",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/documentreference.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A reference to a document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference\"><b>DocumentReference<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.masterIdentifier\"><b>masterIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Master Version Specific Identifier<\/span><span style=\"color: Gray\"> --><\/span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the record.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Other identifiers for the document<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the document<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.htm\">What kind of document this is (LOINC if possible)<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"More detailed information about the document type.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.htm\">More detail about the document type<\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what authored the document<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.custodian\"><b>custodian<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Org which maintains the document<\/span><span style=\"color: Gray\"> --><\/span></custodian>\r\n <<a title=\"Which person or organization authenticates that this document is valid.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.authenticator\"><b>authenticator<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who authenticated the document<\/span><span style=\"color: Gray\"> --><\/span></authenticator>\r\n <<a title=\"When the document was created.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Document creation time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When the document reference was created.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.indexed\"><b>indexed<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">When this document reference created<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of this document reference (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.htm\">current | superseded | error<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the underlying document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.docStatus\"><b>docStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/vs/document-status.htm\">Status of the underlying document<\/a><\/span><span style=\"color: Gray\"> --><\/span></docStatus>\r\n <<a title=\"If this document replaces another (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.supercedes\"><span style=\"text-decoration: underline\"><b>supercedes<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"documentreference.htm#DocumentReference\">DocumentReference<\/a>)<\/span> <span style=\"color: navy\">If this document replaces another<\/span><span style=\"color: Gray\"> --><\/span></supercedes>\r\n <<a title=\"Human Readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human Readable description (title)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-confidentiality.htm\">Sensitivity of source document<\/a><\/span><span style=\"color: Gray\"> --><\/span></confidentiality>\r\n <<a title=\"The primary language in which the source document is written.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.primaryLanguage\"><b>primaryLanguage<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">Primary language of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The mime type of the source document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.mimeType\"><b>mimeType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">Mime type of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The format of the document. This is used when the mimeType of the document does not provide enough differentiating information (typically, when the mime type of the document is text/xml).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.format\"><b>format<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-formatcodes.htm\">Format of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span></format>\r\n <<a title=\"The size of the source document this reference refers to in bytes.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.size\"><b>size<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Size of the document in bytes<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A hash of the source document to ensure that changes have not occurred.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.hash\"><b>hash<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">HexBinary representation of SHA1<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A url at which the document can be accessed.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.location\"><b>location<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A location or a service (or both) must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Where to access the document<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A description of a service call that can be used to retrieve the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service\"><b>service<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A location or a service (or both) must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> If access is not fully described by location --><\/span>\r\n <<a title=\"The type of the service that can be used to access the documents.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-documentreference-service-types.htm\">Type of service (i.e. XDS.b)<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Where the service end-point is located.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.address\"><b>address<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Where service is located (usually a URL)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A list of named parameters that is used in the service call.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter\"><b>parameter<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Service call parameters --><\/span>\r\n <<a title=\"The name of a parameter.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The value of the named parameter.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Parameter value<\/span><span style=\"color: Gray\"> --><\/span>\r\n </parameter>\r\n </service>\r\n <<a title=\"The clinical context in which the document was prepared.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context\"><b>context<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Clinical context of document --><\/span>\r\n <<a title=\"The type of clinical context, such as a kind of surgery, or a kind of speciality, or a clinical type.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-event-code.htm\">Type of context (i.e. type of event)<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The time period of the patient's care that is described by the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time described by the document<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The kind of facility where the patient was seen.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.facilityType\"><b>facilityType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-facilitycodes.htm\">Kind of facility where patient was seen<\/a><\/span><span style=\"color: Gray\"> --><\/span></facilityType>\r\n </context>\r\n</DocumentReference>\r\n<\/pre><\/div>"
},
"name":{
"value":"documentreference"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A reference to a document."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"DocumentReference"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"DocumentReference"
},
"definition":{
"short":{
"value":"A reference to a document"
},
"formal":{
"value":"A reference to a document."
},
"comments":{
"value":"Usually, this is used for documents other than those defined by FHIR."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"Location"
},
"severity":{
"value":"error"
},
"human":{
"value":"A location or a service (or both) must be provided"
},
"xpath":{
"value":"exists(f:location) or exists(f:service)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"XDS Metadata"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.masterIdentifier"
},
"definition":{
"short":{
"value":"Master Version Specific Identifier"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-12-Unique Document Number"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"External ID: 2e82c1f6-a085-4c72-9da3-8640a32e42ab"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.identifier"
},
"definition":{
"short":{
"value":"Other identifiers for the document"
},
"formal":{
"value":"Other identifiers associated with the record."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-16-Unique Document File Name?"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.subject"
},
"definition":{
"short":{
"value":"The subject of the document"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List (No standard way to define a Practitioner or Group subject in V2 MDM message)"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : sourcePatientId + Slot : sourcePatientInfo"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.type"
},
"definition":{
"short":{
"value":"What kind of document this is (LOINC if possible)"
},
"formal":{
"value":"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)."
},
"comments":{
"value":"Key metadata element describing the document, used in searching/filtering."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-2-Document Type"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification: 41a5887f-8865-4c09-adf7-e362475b143a (classCode)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.subtype"
},
"definition":{
"short":{
"value":"More detail about the document type"
},
"formal":{
"value":"More detailed information about the document type."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentSubType"
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification: aa543740-bdda-424e-8c96-df4873be8500 (typeCode)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.author"
},
"definition":{
"short":{
"value":"Who/what authored the document"
},
"formal":{
"value":"Identifies who is responsible for adding the information to the document."
},
"comments":{
"value":"Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant)."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-9-Originator Code/Name (No standard way to indicate a Device in V2 MDM message)"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification: 93606bcf-9494-43ec-9b4e-a7748d1a838d (author)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.custodian"
},
"definition":{
"short":{
"value":"Org which maintains the document"
},
"formal":{
"value":"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document."
},
"comments":{
"value":"Identifies where to go to find the current version, where to report issues, etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"n/a"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.authenticator"
},
"definition":{
"short":{
"value":"Who authenticated the document"
},
"formal":{
"value":"Which person or organization authenticates that this document is valid."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-10-Assigned Document Authenticator"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"?"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.created"
},
"definition":{
"short":{
"value":"Document creation time"
},
"formal":{
"value":"When the document was created."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-6-Origination Date/Time"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : creationTime"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.indexed"
},
"definition":{
"short":{
"value":"When this document reference created"
},
"formal":{
"value":"When the document reference was created."
},
"comments":{
"value":"Referencing/indexing time is used for tracking, organizing versions and searching."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : creationTime"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.status"
},
"definition":{
"short":{
"value":"current | superseded | error"
},
"formal":{
"value":"The status of this document reference."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"DocumentReferenceStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-19-Document Availability Status"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"implied by XDS workflow"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.docStatus"
},
"definition":{
"short":{
"value":"Status of the underlying document"
},
"formal":{
"value":"The status of the underlying document."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ReferredDocumentStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-17-Document Completion Status"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"n/a ?"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.supercedes"
},
"definition":{
"short":{
"value":"If this document replaces another"
},
"formal":{
"value":"If this document replaces another."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(DocumentReference)"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"todo"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.description"
},
"definition":{
"short":{
"value":"Human Readable description (title)"
},
"formal":{
"value":"Human Readable description of the source document. This is sometimes known as the \"title\"."
},
"comments":{
"value":"What the document is about, rather than a terse summary of the document. It's 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\")."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-25-Document Title"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"ExtrinsicObject/Name"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.confidentiality"
},
"definition":{
"short":{
"value":"Sensitivity of source document"
},
"formal":{
"value":"A code specifying the level of confidentiality of the XDS Document."
},
"comments":{
"value":"The interpretation of this field, and more generally enforcement and issues related to highly sensitive documents are beyond the scope of this resource. confidentialityCode can only be understood in the context of the policies, procedures, and value set specified by the context in which the document reference is being used."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"DocumentConfidentiality"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-18-Document Confidentiality Status"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification: f4f85eac-e6cb-4883-b524-f2705394840f (confidentialityCode)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.primaryLanguage"
},
"definition":{
"short":{
"value":"Primary language of the document"
},
"formal":{
"value":"The primary language in which the source document is written."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Language"
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : languageCode"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.mimeType"
},
"definition":{
"short":{
"value":"Mime type of the document"
},
"formal":{
"value":"The mime type of the source document."
},
"comments":{
"value":"Note: application/hl7-v3+xml for CDA. application/binary for proprietary record formats."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MimeType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TXA-3-Document Content Presentation"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"ExtrinsicObject/@mimeType"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.format"
},
"definition":{
"short":{
"value":"Format of the document"
},
"formal":{
"value":"The format of the document. This is used when the mimeType of the document does not provide enough differentiating information (typically, when the mime type of the document is text/xml)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentFormat"
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification: a09d5840-386c-46f2-b5ad-9c3699a4309d (formatCode)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.size"
},
"definition":{
"short":{
"value":"Size of the document in bytes"
},
"formal":{
"value":"The size of the source document this reference refers to in bytes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : size"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.hash"
},
"definition":{
"short":{
"value":"HexBinary representation of SHA1"
},
"formal":{
"value":"A hash of the source document to ensure that changes have not occurred."
},
"comments":{
"value":"Whether the hash must be present and/or correct depends on the document handling rules defined in the context of use."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : hash"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.location"
},
"definition":{
"short":{
"value":"Where to access the document"
},
"formal":{
"value":"A url at which the document can be accessed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(Might include V2 TXA-16-Unique Document File Name or TXA-24-Folder Assignment)"
}
},
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"repository location (by implication & configuration)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.service"
},
"definition":{
"short":{
"value":"If access is not fully described by location"
},
"formal":{
"value":"A description of a service call that can be used to retrieve the document."
},
"comments":{
"value":"If a document can be accessed by either a service or directly by a URL (i.e. an XDS repository with an MHD access point, or a DICOM network with a WADO portal) just provide the URL."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"determined from repository location + parameters"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.service.type"
},
"definition":{
"short":{
"value":"Type of service (i.e. XDS.b)"
},
"formal":{
"value":"The type of the service that can be used to access the documents."
},
"comments":{
"value":"The meaning and interpretation of the parameters depends on the service type."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentServiceType"
}
}
},
{
"path":{
"value":"DocumentReference.service.address"
},
"definition":{
"short":{
"value":"Where service is located (usually a URL)"
},
"formal":{
"value":"Where the service end-point is located."
},
"comments":{
"value":"Usually this is a URL, but for some services, the end-point is a simple network name or address that is not a valid URL."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.service.parameter"
},
"definition":{
"short":{
"value":"Service call parameters"
},
"formal":{
"value":"A list of named parameters that is used in the service call."
},
"comments":{
"value":"The interpretation of the parameters, and how to convert them into a proper service call, is dependent on the type of the service, and needs to be specified in an implementation guide somewhere."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.service.parameter.name"
},
"definition":{
"short":{
"value":"Name of parameter"
},
"formal":{
"value":"The name of a parameter."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.service.parameter.value"
},
"definition":{
"short":{
"value":"Parameter value"
},
"formal":{
"value":"The value of the named parameter."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"DocumentReference.context"
},
"definition":{
"short":{
"value":"Clinical context of document"
},
"formal":{
"value":"The clinical context in which the document was prepared."
},
"comments":{
"value":"These values are primarily added to help with searching for interesting/relevant documents."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"(if needed)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.context.code"
},
"definition":{
"short":{
"value":"Type of context (i.e. type of event)"
},
"formal":{
"value":"The type of clinical context, such as a kind of surgery, or a kind of speciality, or a clinical type."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentEventCode"
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification : cccf5598-8b07-4b77-a05e-ae952c785ead (practice setting)"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.context.period"
},
"definition":{
"short":{
"value":"Time described by the document"
},
"formal":{
"value":"The time period of the patient's care that is described by the document."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Slot : serviceStartTime & Slot : serviceStopTime"
}
}
]
}
},
{
"path":{
"value":"DocumentReference.context.facilityType"
},
"definition":{
"short":{
"value":"Kind of facility where patient was seen"
},
"formal":{
"value":"The kind of facility where the patient was seen."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DocumentFacilityType"
},
"mapping":[
{
"target":{
"value":"http://ihe.net/xds"
},
"map":{
"value":"Classification : f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1 (healthcare Facility Type)"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"DocumentSubType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/xds-typecodes"
}
}
},
{
"name":{
"value":"DocumentEventCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-event-code"
}
}
},
{
"name":{
"value":"DocumentConfidentiality"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-confidentiality"
}
}
},
{
"name":{
"value":"ReferredDocumentStatus"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/document-status"
}
}
},
{
"name":{
"value":"MimeType"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://www.rfc-editor.org/bcp/bcp13.txt"
}
},
{
"name":{
"value":"DocumentFormat"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/xds-formatcodes"
}
}
},
{
"name":{
"value":"Language"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://tools.ietf.org/html/bcp47"
}
},
{
"name":{
"value":"DocumentType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/doc-codes"
}
}
},
{
"name":{
"value":"DocumentFacilityType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/xds-facilitycodes"
}
}
},
{
"name":{
"value":"DocumentServiceType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/documentreference-service-types"
}
}
},
{
"name":{
"value":"DocumentReferenceStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/document-reference-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A reference to a document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference\"><b>DocumentReference<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.masterIdentifier\"><b>masterIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Master Version Specific Identifier<\/span><span style=\"color: Gray\"> --><\/span></masterIdentifier>\r\n <<a title=\"Other identifiers associated with the record.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Other identifiers for the document<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">The subject of the document<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-codes.htm\">What kind of document this is (LOINC if possible)<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"More detailed information about the document type.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-typecodes.htm\">More detail about the document type<\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Identifies who is responsible for adding the information to the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what authored the document<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.custodian\"><b>custodian<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Org which maintains the document<\/span><span style=\"color: Gray\"> --><\/span></custodian>\r\n <<a title=\"Which person or organization authenticates that this document is valid.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.authenticator\"><b>authenticator<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who authenticated the document<\/span><span style=\"color: Gray\"> --><\/span></authenticator>\r\n <<a title=\"When the document was created.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Document creation time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When the document reference was created.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.indexed\"><b>indexed<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">When this document reference created<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of this document reference (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"document-reference-status.htm\">current | superseded | error<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the underlying document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.docStatus\"><b>docStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/vs/document-status.htm\">Status of the underlying document<\/a><\/span><span style=\"color: Gray\"> --><\/span></docStatus>\r\n <<a title=\"If this document replaces another (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.supercedes\"><span style=\"text-decoration: underline\"><b>supercedes<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"documentreference.htm#DocumentReference\">DocumentReference<\/a>)<\/span> <span style=\"color: navy\">If this document replaces another<\/span><span style=\"color: Gray\"> --><\/span></supercedes>\r\n <<a title=\"Human Readable description of the source document. This is sometimes known as the "title".\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human Readable description (title)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code specifying the level of confidentiality of the XDS Document (this element modifies the meaning of other elements)\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.confidentiality\"><span style=\"text-decoration: underline\"><b>confidentiality<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-confidentiality.htm\">Sensitivity of source document<\/a><\/span><span style=\"color: Gray\"> --><\/span></confidentiality>\r\n <<a title=\"The primary language in which the source document is written.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.primaryLanguage\"><b>primaryLanguage<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">Primary language of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The mime type of the source document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.mimeType\"><b>mimeType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://www.rfc-editor.org/bcp/bcp13.txt.htm\">Mime type of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The format of the document. This is used when the mimeType of the document does not provide enough differentiating information (typically, when the mime type of the document is text/xml).\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.format\"><b>format<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-formatcodes.htm\">Format of the document<\/a><\/span><span style=\"color: Gray\"> --><\/span></format>\r\n <<a title=\"The size of the source document this reference refers to in bytes.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.size\"><b>size<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Size of the document in bytes<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A hash of the source document to ensure that changes have not occurred.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.hash\"><b>hash<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">HexBinary representation of SHA1<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A url at which the document can be accessed.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.location\"><b>location<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A location or a service (or both) must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Where to access the document<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A description of a service call that can be used to retrieve the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service\"><b>service<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A location or a service (or both) must be provided\" style=\"color: deeppink\"><b>0..1<\/b><\/span> If access is not fully described by location --><\/span>\r\n <<a title=\"The type of the service that can be used to access the documents.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-documentreference-service-types.htm\">Type of service (i.e. XDS.b)<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Where the service end-point is located.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.address\"><b>address<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Where service is located (usually a URL)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A list of named parameters that is used in the service call.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter\"><b>parameter<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Service call parameters --><\/span>\r\n <<a title=\"The name of a parameter.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of parameter<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The value of the named parameter.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.service.parameter.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Parameter value<\/span><span style=\"color: Gray\"> --><\/span>\r\n </parameter>\r\n </service>\r\n <<a title=\"The clinical context in which the document was prepared.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context\"><b>context<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Clinical context of document --><\/span>\r\n <<a title=\"The type of clinical context, such as a kind of surgery, or a kind of speciality, or a clinical type.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-doc-event-code.htm\">Type of context (i.e. type of event)<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The time period of the patient's care that is described by the document.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time described by the document<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The kind of facility where the patient was seen.\" class=\"dict\" href=\"documentreference-definitions.htm#DocumentReference.context.facilityType\"><b>facilityType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-xds-facilitycodes.htm\">Kind of facility where patient was seen<\/a><\/span><span style=\"color: Gray\"> --><\/span></facilityType>\r\n </context>\r\n</DocumentReference>\r\n<\/pre><\/div>"
},
{
"title":"\"encounter\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/encounter",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/encounter.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter\"><b>Encounter<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier(s) by which this encounter is known.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier(s) by which this encounter is known<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"E.g. active, aborted, finished (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-state.htm\">E.g. active, aborted, finished<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Inpatient | Outpatient etc (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.class\"><span style=\"text-decoration: underline\"><b>class<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-class.htm\">Inpatient | Outpatient etc<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-type.htm\">Specific type of encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The patient present at the encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The patient present at the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The main practitioner responsible for providing the service.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> List of participants involved in the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Role of participant in encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"participant-type.htm\">Role of participant in encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The practitioner that is involved.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant.practitioner\"><b>practitioner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The practitioner that is involved<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></practitioner>\r\n </participant>\r\n <<a title=\"The appointment that scheduled this encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.fulfills\"><b>fulfills<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a title=\"This resource has not been defined yet\">Appointment<\/a>)<\/span> <span style=\"color: navy\">The appointment that scheduled this encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></fulfills>\r\n <<a title=\"The date and time the encounter starts, e.g. the patient arrives.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.start\"><b>start<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time the encounter starts<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Quantity of time the encounter lasted. This excludes the time during leaves of absence.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.length\"><b>length<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Duration\">Duration<\/a><\/span> <span style=\"color: navy\">Quantity of time the encounter lasted<\/span><span style=\"color: Gray\"> --><\/span></length>\r\n <<a title=\"Reason the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.reason_x_\"><b>reason[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason the encounter takes place<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></reason[x]>\r\n <<a title=\"Reason the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.indication\"><b>indication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Reason the encounter takes place<\/span><span style=\"color: Gray\"> --><\/span></indication>\r\n <<a title=\"Indicates the urgency of the encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.priority\"><b>priority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-priority.htm\">Indicates the urgency of the encounter<\/a><\/span><span style=\"color: Gray\"> --><\/span></priority>\r\n <<a title=\"Details about an admission to a clinic.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization\"><b>hospitalization<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Details about an admission to a clinic --><\/span>\r\n <<a title=\"Pre-admission identifier.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.preAdmissionIdentifier\"><b>preAdmissionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Pre-admission identifier<\/span><span style=\"color: Gray\"> --><\/span></preAdmissionIdentifier>\r\n <<a title=\"The location the patient came from before admission.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.origin\"><b>origin<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">The location the patient came from before admission<\/span><span style=\"color: Gray\"> --><\/span></origin>\r\n <<a title=\"Where patient was admitted from (physician referral, transfer).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.admitSource\"><b>admitSource<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-admit-source.htm\">Where patient was admitted from (physician referral, transfer)<\/a><\/span><span style=\"color: Gray\"> --><\/span></admitSource>\r\n <<a title=\"Period of hospitalization.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period of hospitalization<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Where the patient stays during this encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation\"><b>accomodation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Where the patient stays during this encounter --><\/span>\r\n <<a title=\"Bed.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation.bed\"><b>bed<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Bed<\/span><span style=\"color: Gray\"> --><\/span></bed>\r\n <<a title=\"Period during which the patient was assigned the bed.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period during which the patient was assigned the bed<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n </accomodation>\r\n <<a title=\"Dietary restrictions for the patient.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.diet\"><b>diet<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-diet.htm\">Dietary restrictions for the patient<\/a><\/span><span style=\"color: Gray\"> --><\/span></diet>\r\n <<a title=\"Special courtesies (VIP, board member).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.specialCourtesy\"><b>specialCourtesy<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-courtesy.htm\">Special courtesies (VIP, board member)<\/a><\/span><span style=\"color: Gray\"> --><\/span></specialCourtesy>\r\n <<a title=\"Wheelchair, translator, stretcher, etc.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.specialArrangement\"><b>specialArrangement<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-arrangements.htm\">Wheelchair, translator, stretcher, etc<\/a><\/span><span style=\"color: Gray\"> --><\/span></specialArrangement>\r\n <<a title=\"Location the patient is discharged to.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Location the patient is discharged to<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Disposition patient released to.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.dischargeDisposition\"><b>dischargeDisposition<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-discharge-disposition.htm\">Disposition patient released to<\/a><\/span><span style=\"color: Gray\"> --><\/span></dischargeDisposition>\r\n <<a title=\"Is readmission?.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.reAdmission\"><b>reAdmission<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Is readmission?<\/span><span style=\"color: Gray\"> --><\/span>\r\n </hospitalization>\r\n <<a title=\"List of locations the patient has been at.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location\"><b>location<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> List of locations the patient has been at --><\/span>\r\n <<a title=\"The location the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">The location the encounter takes place<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Time period during which the patient was present at the location.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time period during which the patient was present at the location<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n </location>\r\n <<a title=\"Department or team providing care.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.serviceProvider\"><b>serviceProvider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Department or team providing care<\/span><span style=\"color: Gray\"> --><\/span></serviceProvider>\r\n <<a title=\"Another Encounter this encounter is part of (administratively or in time).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Another Encounter this encounter is part of<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n</Encounter>\r\n<\/pre><\/div>"
},
"name":{
"value":"encounter"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Encounter"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Encounter"
},
"definition":{
"short":{
"value":"An interaction during which services are provided to the patient"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.identifier"
},
"definition":{
"short":{
"value":"Identifier(s) by which this encounter is known"
},
"formal":{
"value":"Identifier(s) by which this encounter is known."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-19-visit number"
}
}
]
}
},
{
"path":{
"value":"Encounter.status"
},
"definition":{
"short":{
"value":"E.g. active, aborted, finished"
},
"formal":{
"value":"E.g. active, aborted, finished."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"EncounterState"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Encounter.class"
},
"definition":{
"short":{
"value":"Inpatient | Outpatient etc"
},
"formal":{
"value":"Inpatient | Outpatient etc."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"EncounterClass"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-2-patient class"
}
}
]
}
},
{
"path":{
"value":"Encounter.type"
},
"definition":{
"short":{
"value":"Specific type of encounter"
},
"formal":{
"value":"Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation)."
},
"comments":{
"value":"Since there are many ways to further classify encounters, this element is 0..*."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"EncounterType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-4-admission type"
}
}
]
}
},
{
"path":{
"value":"Encounter.subject"
},
"definition":{
"short":{
"value":"The patient present at the encounter"
},
"formal":{
"value":"The patient present at the encounter."
},
"comments":{
"value":"While the encounter is always about the patient, the patient may not actually be known in all contexts of use."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"Encounter.participant"
},
"definition":{
"short":{
"value":"List of participants involved in the encounter"
},
"formal":{
"value":"The main practitioner responsible for providing the service."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.participant.type"
},
"definition":{
"short":{
"value":"Role of participant in encounter"
},
"formal":{
"value":"Role of participant in encounter."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ParticipantType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-4-participation"
}
}
]
}
},
{
"path":{
"value":"Encounter.participant.practitioner"
},
"definition":{
"short":{
"value":"The practitioner that is involved"
},
"formal":{
"value":"The practitioner that is involved."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-5-participation person"
}
}
]
}
},
{
"path":{
"value":"Encounter.fulfills"
},
"definition":{
"short":{
"value":"The appointment that scheduled this encounter"
},
"formal":{
"value":"The appointment that scheduled this encounter."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Appointment)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"SCH-1-placer appointment ID / SCH-2-filler appointment ID"
}
}
]
}
},
{
"path":{
"value":"Encounter.start"
},
"definition":{
"short":{
"value":"The date and time the encounter starts"
},
"formal":{
"value":"The date and time the encounter starts, e.g. the patient arrives."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.length"
},
"definition":{
"short":{
"value":"Quantity of time the encounter lasted"
},
"formal":{
"value":"Quantity of time the encounter lasted. This excludes the time during leaves of absence."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Duration"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(PV1-45 less PV1-44) iff ( (PV1-44 not empty) and (PV1-45 not empty) ); units in minutes"
}
}
]
}
},
{
"path":{
"value":"Encounter.reason[x]"
},
"definition":{
"short":{
"value":"Reason the encounter takes place"
},
"formal":{
"value":"Reason the encounter takes place."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"EncounterReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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)"
}
}
]
}
},
{
"path":{
"value":"Encounter.indication"
},
"definition":{
"short":{
"value":"Reason the encounter takes place"
},
"formal":{
"value":"Reason the encounter takes place."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.priority"
},
"definition":{
"short":{
"value":"Indicates the urgency of the encounter"
},
"formal":{
"value":"Indicates the urgency of the encounter."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Priority"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV2-25-visit priority code"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization"
},
"definition":{
"short":{
"value":"Details about an admission to a clinic"
},
"formal":{
"value":"Details about an admission to a clinic."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.hospitalization.preAdmissionIdentifier"
},
"definition":{
"short":{
"value":"Pre-admission identifier"
},
"formal":{
"value":"Pre-admission identifier."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-5-preadmit number"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.origin"
},
"definition":{
"short":{
"value":"The location the patient came from before admission"
},
"formal":{
"value":"The location the patient came from before admission."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.hospitalization.admitSource"
},
"definition":{
"short":{
"value":"Where patient was admitted from (physician referral, transfer)"
},
"formal":{
"value":"Where patient was admitted from (physician referral, transfer)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdmitSource"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-14-admit source"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.period"
},
"definition":{
"short":{
"value":"Period of hospitalization"
},
"formal":{
"value":"Period of hospitalization."
},
"comments":{
"value":"May differ from start + length, since length excludes leaves of absence."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV2-11-actual length of inpatient stay / PV1-44-admit date/time / PV1-45-discharge date/time"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.accomodation"
},
"definition":{
"short":{
"value":"Where the patient stays during this encounter"
},
"formal":{
"value":"Where the patient stays during this encounter."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.hospitalization.accomodation.bed"
},
"definition":{
"short":{
"value":"Bed"
},
"formal":{
"value":"Bed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-3-assigned patient location"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.accomodation.period"
},
"definition":{
"short":{
"value":"Period during which the patient was assigned the bed"
},
"formal":{
"value":"Period during which the patient was assigned the bed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.hospitalization.diet"
},
"definition":{
"short":{
"value":"Dietary restrictions for the patient"
},
"formal":{
"value":"Dietary restrictions for the patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"PatientDiet"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-38-diet type"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.specialCourtesy"
},
"definition":{
"short":{
"value":"Special courtesies (VIP, board member)"
},
"formal":{
"value":"Special courtesies (VIP, board member)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Courtesies"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-16-VIP indicator"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.specialArrangement"
},
"definition":{
"short":{
"value":"Wheelchair, translator, stretcher, etc"
},
"formal":{
"value":"Wheelchair, translator, stretcher, etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Arrangements"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-15-ambulatory status / OBR-30-transportation mode / OBR-43-planned patient transport comment"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.destination"
},
"definition":{
"short":{
"value":"Location the patient is discharged to"
},
"formal":{
"value":"Location the patient is discharged to."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.hospitalization.dischargeDisposition"
},
"definition":{
"short":{
"value":"Disposition patient released to"
},
"formal":{
"value":"Disposition patient released to."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DischargeDisp"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-36-discharge disposition"
}
}
]
}
},
{
"path":{
"value":"Encounter.hospitalization.reAdmission"
},
"definition":{
"short":{
"value":"Is readmission?"
},
"formal":{
"value":"Is readmission?."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-13-re-admission indicator"
}
}
]
}
},
{
"path":{
"value":"Encounter.location"
},
"definition":{
"short":{
"value":"List of locations the patient has been at"
},
"formal":{
"value":"List of locations the patient has been at."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.location.location"
},
"definition":{
"short":{
"value":"The location the encounter takes place"
},
"formal":{
"value":"The location the encounter takes place."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-3-assigned patient location / PV1-6-prior patient location / PV1-11-temporary location / PV1-42-pending location / PV1-43-prior temporary location"
}
}
]
}
},
{
"path":{
"value":"Encounter.location.period"
},
"definition":{
"short":{
"value":"Time period during which the patient was present at the location"
},
"formal":{
"value":"Time period during which the patient was present at the location."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Encounter.serviceProvider"
},
"definition":{
"short":{
"value":"Department or team providing care"
},
"formal":{
"value":"Department or team providing care."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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)"
}
}
]
}
},
{
"path":{
"value":"Encounter.partOf"
},
"definition":{
"short":{
"value":"Another Encounter this encounter is part of"
},
"formal":{
"value":"Another Encounter this encounter is part of (administratively or in time)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"DischargeDisp"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-discharge-disposition"
}
}
},
{
"name":{
"value":"Courtesies"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-special-courtesy"
}
}
},
{
"name":{
"value":"EncounterClass"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-class"
}
}
},
{
"name":{
"value":"EncounterType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-type"
}
}
},
{
"name":{
"value":"Arrangements"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-special-arrangements"
}
}
},
{
"name":{
"value":"PatientDiet"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-diet"
}
}
},
{
"name":{
"value":"AdmitSource"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-admit-source"
}
}
},
{
"name":{
"value":"EncounterReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Reason"
}
},
{
"name":{
"value":"ParticipantType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/participant-type"
}
}
},
{
"name":{
"value":"Priority"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-priority"
}
}
},
{
"name":{
"value":"EncounterState"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/encounter-state"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter\"><b>Encounter<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier(s) by which this encounter is known.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier(s) by which this encounter is known<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"E.g. active, aborted, finished (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-state.htm\">E.g. active, aborted, finished<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Inpatient | Outpatient etc (this element modifies the meaning of other elements)\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.class\"><span style=\"text-decoration: underline\"><b>class<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"encounter-class.htm\">Inpatient | Outpatient etc<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-type.htm\">Specific type of encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The patient present at the encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The patient present at the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The main practitioner responsible for providing the service.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> List of participants involved in the encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Role of participant in encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"participant-type.htm\">Role of participant in encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The practitioner that is involved.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.participant.practitioner\"><b>practitioner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The practitioner that is involved<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></practitioner>\r\n </participant>\r\n <<a title=\"The appointment that scheduled this encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.fulfills\"><b>fulfills<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a title=\"This resource has not been defined yet\">Appointment<\/a>)<\/span> <span style=\"color: navy\">The appointment that scheduled this encounter<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></fulfills>\r\n <<a title=\"The date and time the encounter starts, e.g. the patient arrives.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.start\"><b>start<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time the encounter starts<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Quantity of time the encounter lasted. This excludes the time during leaves of absence.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.length\"><b>length<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Duration\">Duration<\/a><\/span> <span style=\"color: navy\">Quantity of time the encounter lasted<\/span><span style=\"color: Gray\"> --><\/span></length>\r\n <<a title=\"Reason the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.reason_x_\"><b>reason[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason the encounter takes place<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></reason[x]>\r\n <<a title=\"Reason the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.indication\"><b>indication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Reason the encounter takes place<\/span><span style=\"color: Gray\"> --><\/span></indication>\r\n <<a title=\"Indicates the urgency of the encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.priority\"><b>priority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-priority.htm\">Indicates the urgency of the encounter<\/a><\/span><span style=\"color: Gray\"> --><\/span></priority>\r\n <<a title=\"Details about an admission to a clinic.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization\"><b>hospitalization<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Details about an admission to a clinic --><\/span>\r\n <<a title=\"Pre-admission identifier.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.preAdmissionIdentifier\"><b>preAdmissionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Pre-admission identifier<\/span><span style=\"color: Gray\"> --><\/span></preAdmissionIdentifier>\r\n <<a title=\"The location the patient came from before admission.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.origin\"><b>origin<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">The location the patient came from before admission<\/span><span style=\"color: Gray\"> --><\/span></origin>\r\n <<a title=\"Where patient was admitted from (physician referral, transfer).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.admitSource\"><b>admitSource<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-admit-source.htm\">Where patient was admitted from (physician referral, transfer)<\/a><\/span><span style=\"color: Gray\"> --><\/span></admitSource>\r\n <<a title=\"Period of hospitalization.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period of hospitalization<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Where the patient stays during this encounter.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation\"><b>accomodation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Where the patient stays during this encounter --><\/span>\r\n <<a title=\"Bed.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation.bed\"><b>bed<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Bed<\/span><span style=\"color: Gray\"> --><\/span></bed>\r\n <<a title=\"Period during which the patient was assigned the bed.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.accomodation.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period during which the patient was assigned the bed<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n </accomodation>\r\n <<a title=\"Dietary restrictions for the patient.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.diet\"><b>diet<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-diet.htm\">Dietary restrictions for the patient<\/a><\/span><span style=\"color: Gray\"> --><\/span></diet>\r\n <<a title=\"Special courtesies (VIP, board member).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.specialCourtesy\"><b>specialCourtesy<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-courtesy.htm\">Special courtesies (VIP, board member)<\/a><\/span><span style=\"color: Gray\"> --><\/span></specialCourtesy>\r\n <<a title=\"Wheelchair, translator, stretcher, etc.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.specialArrangement\"><b>specialArrangement<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-special-arrangements.htm\">Wheelchair, translator, stretcher, etc<\/a><\/span><span style=\"color: Gray\"> --><\/span></specialArrangement>\r\n <<a title=\"Location the patient is discharged to.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Location the patient is discharged to<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Disposition patient released to.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.dischargeDisposition\"><b>dischargeDisposition<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-encounter-discharge-disposition.htm\">Disposition patient released to<\/a><\/span><span style=\"color: Gray\"> --><\/span></dischargeDisposition>\r\n <<a title=\"Is readmission?.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.hospitalization.reAdmission\"><b>reAdmission<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Is readmission?<\/span><span style=\"color: Gray\"> --><\/span>\r\n </hospitalization>\r\n <<a title=\"List of locations the patient has been at.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location\"><b>location<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> List of locations the patient has been at --><\/span>\r\n <<a title=\"The location the encounter takes place.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">The location the encounter takes place<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Time period during which the patient was present at the location.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.location.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time period during which the patient was present at the location<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n </location>\r\n <<a title=\"Department or team providing care.\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.serviceProvider\"><b>serviceProvider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Department or team providing care<\/span><span style=\"color: Gray\"> --><\/span></serviceProvider>\r\n <<a title=\"Another Encounter this encounter is part of (administratively or in time).\" class=\"dict\" href=\"encounter-definitions.htm#Encounter.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Another Encounter this encounter is part of<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n</Encounter>\r\n<\/pre><\/div>"
},
{
"title":"\"familyhistory\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/familyhistory",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/familyhistory.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Significant health events and conditions for people related to the subject relevant in the context of care for the subject.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory\"><b>FamilyHistory<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The person who this history concerns.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this history<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Conveys information about family history not specific to individual relations.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional details<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The related person. Each FamilyHistory resource contains the entire family history for a single person.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation\"><b>relation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The relation --><\/span>\r\n <<a title=\"This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair".\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The family member who had the condition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of relationship this person has to the patient (father, mother, brother etc.) At the moment this is a code linking to a fixed set of values. I'm not sure if there is an international standard for this. A fixed (possibly extensible) set of codes feels better than a codeable concept for something like this...\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"familial-relationship.htm\">Relationship to the subject<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.deceased_x_\"><b>deceased[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Is the person deceased<\/span><span style=\"color: Gray\"> --><\/span></deceased[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General note about the related person<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition\"><b>condition<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The Condition that the related person had --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The condition<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.outcome\"><b>outcome<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">deceased | permanent disability | etc.<\/span><span style=\"color: Gray\"> --><\/span></outcome>\r\n <<a title=\"Either the age of onset, range of approximate age or descriptive string can be recorded.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.onset_x_\"><b>onset[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">How old the person was when the condition manifested<\/span><span style=\"color: Gray\"> --><\/span></onset[x]>\r\n <<a title=\"An area where general notes can be placed about this specific condition.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General notes<\/span><span style=\"color: Gray\"> --><\/span>\r\n </condition>\r\n </relation>\r\n</FamilyHistory>\r\n<\/pre><\/div>"
},
"name":{
"value":"familyhistory"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Significant health events and conditions for people related to the subject relevant in the context of care for the subject."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"FamilyHistory"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"FamilyHistory"
},
"definition":{
"short":{
"value":"Family History"
},
"formal":{
"value":"Significant health events and conditions for people related to the subject relevant in the context of care for the subject."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"Not in scope for v2"
}
}
]
}
},
{
"path":{
"value":"FamilyHistory.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.subject"
},
"definition":{
"short":{
"value":"Subject of this history"
},
"formal":{
"value":"The person who this history concerns."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.note"
},
"definition":{
"short":{
"value":"Additional details"
},
"formal":{
"value":"Conveys information about family history not specific to individual relations."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation"
},
"definition":{
"short":{
"value":"The relation"
},
"formal":{
"value":"The related person. Each FamilyHistory resource contains the entire family history for a single person."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.name"
},
"definition":{
"short":{
"value":"The family member who had the condition"
},
"formal":{
"value":"This will either be a name or a description. E.g. \"Aunt Susan\", \"my cousin with the red hair\"."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.relationship"
},
"definition":{
"short":{
"value":"Relationship to the subject"
},
"formal":{
"value":"The type of relationship this person has to the patient (father, mother, brother etc.) At the moment this is a code linking to a fixed set of values. I'm not sure if there is an international standard for this. A fixed (possibly extensible) set of codes feels better than a codeable concept for something like this..."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"FamilialRelationship"
}
}
},
{
"path":{
"value":"FamilyHistory.relation.deceased[x]"
},
"definition":{
"short":{
"value":"Is the person deceased"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
},
{
"code":{
"value":"Age"
}
},
{
"code":{
"value":"Range"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.note"
},
"definition":{
"short":{
"value":"General note about the related person"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.condition"
},
"definition":{
"short":{
"value":"The Condition that the related person had"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.condition.type"
},
"definition":{
"short":{
"value":"The condition"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.condition.outcome"
},
"definition":{
"short":{
"value":"deceased | permanent disability | etc."
},
"formal":{
"value":"Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConditionOutcome"
}
}
},
{
"path":{
"value":"FamilyHistory.relation.condition.onset[x]"
},
"definition":{
"short":{
"value":"How old the person was when the condition manifested"
},
"formal":{
"value":"Either the age of onset, range of approximate age or descriptive string can be recorded."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Age"
}
},
{
"code":{
"value":"Range"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"FamilyHistory.relation.condition.note"
},
"definition":{
"short":{
"value":"General notes"
},
"formal":{
"value":"An area where general notes can be placed about this specific condition."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"FamilialRelationship"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/familial-relationship"
}
}
},
{
"name":{
"value":"ConditionOutcome"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The result of the condition for the patient. E.g. death, permanent disability, temporary disability, etc."
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Significant health events and conditions for people related to the subject relevant in the context of care for the subject.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory\"><b>FamilyHistory<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The person who this history concerns.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this history<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Conveys information about family history not specific to individual relations.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional details<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The related person. Each FamilyHistory resource contains the entire family history for a single person.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation\"><b>relation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The relation --><\/span>\r\n <<a title=\"This will either be a name or a description. E.g. "Aunt Susan", "my cousin with the red hair".\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The family member who had the condition<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of relationship this person has to the patient (father, mother, brother etc.) At the moment this is a code linking to a fixed set of values. I'm not sure if there is an international standard for this. A fixed (possibly extensible) set of codes feels better than a codeable concept for something like this...\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"familial-relationship.htm\">Relationship to the subject<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.deceased_x_\"><b>deceased[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Is the person deceased<\/span><span style=\"color: Gray\"> --><\/span></deceased[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General note about the related person<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition\"><b>condition<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The Condition that the related person had --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The condition<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.outcome\"><b>outcome<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">deceased | permanent disability | etc.<\/span><span style=\"color: Gray\"> --><\/span></outcome>\r\n <<a title=\"Either the age of onset, range of approximate age or descriptive string can be recorded.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.onset_x_\"><b>onset[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Age\">Age<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">How old the person was when the condition manifested<\/span><span style=\"color: Gray\"> --><\/span></onset[x]>\r\n <<a title=\"An area where general notes can be placed about this specific condition.\" class=\"dict\" href=\"familyhistory-definitions.htm#FamilyHistory.relation.condition.note\"><b>note<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">General notes<\/span><span style=\"color: Gray\"> --><\/span>\r\n </condition>\r\n </relation>\r\n</FamilyHistory>\r\n<\/pre><\/div>"
},
{
"title":"\"group\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/group",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/group.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"group-definitions.htm#Group\"><b>Group<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"A unique business identifier for this group.\" class=\"dict\" href=\"group-definitions.htm#Group.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Unique id<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies the broad classification of the kind of resources the group includes.\" class=\"dict\" href=\"group-definitions.htm#Group.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"group-type.htm\">Group Classification<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.\" class=\"dict\" href=\"group-definitions.htm#Group.actual\"><b>actual<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Descriptive or actual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc.\" class=\"dict\" href=\"group-definitions.htm#Group.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Kind of Group members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A label assigned to the group for human identification and communication.\" class=\"dict\" href=\"group-definitions.htm#Group.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Label for Group<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A count of the number of resource instances that are part of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.quantity\"><b>quantity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the traits shared by members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic\"><b>characteristic<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Trait of group members --><\/span>\r\n <<a title=\"Identifies the kind of trait being asserted.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Kind of characteristic<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a><\/span> <span style=\"color: navy\">Value held by characteristic<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.exclude\"><span style=\"text-decoration: underline\"><b>exclude<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Group includes or excludes<\/span><span style=\"color: Gray\"> --><\/span>\r\n </characteristic>\r\n <<a title=\"Identifies the resource instances that are members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.member\"><b>member<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Who is in group<\/span><span style=\"color: Gray\"> --><\/span></member>\r\n</Group>\r\n<\/pre><\/div>"
},
"name":{
"value":"group"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Group"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Group"
},
"definition":{
"short":{
"value":"Group of multiple entities"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"No members for non-actual"
},
"severity":{
"value":"error"
},
"human":{
"value":"Can only have members if group is \"actual\""
},
"xpath":{
"value":"f:actual/@value='true' or not(exists(f:member))"
}
},
{
"key":{
"value":"4"
},
"name":{
"value":"No more members than quantity"
},
"severity":{
"value":"error"
},
"human":{
"value":"Can't have more members associated with the group than the value specified for \"quantity\""
},
"xpath":{
"value":"not(f:quantity) or not(f:member) or not(f:quantity>count(f:member))"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Entity[determinerCode=\"GRP\" or determinerCode=\"GRP_KIND\"]"
}
}
]
}
},
{
"path":{
"value":"Group.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Group.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Group.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Group.identifier"
},
"definition":{
"short":{
"value":"Unique id"
},
"formal":{
"value":"A unique business identifier for this group."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
}
]
}
},
{
"path":{
"value":"Group.type"
},
"definition":{
"short":{
"value":"Group Classification"
},
"formal":{
"value":"Identifies the broad classification of the kind of resources the group includes."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"GroupType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"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":{
"value":"Group.actual"
},
"definition":{
"short":{
"value":"Descriptive or actual"
},
"formal":{
"value":"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"true: ./determinerCode=\"GRP\"\n\nfalse: ./determinerCode=\"GRP_KIND\""
}
}
]
}
},
{
"path":{
"value":"Group.code"
},
"definition":{
"short":{
"value":"Kind of Group members"
},
"formal":{
"value":"Provides a specific type of resource the group includes. E.g. \"cow\", \"syringe\", etc."
},
"comments":{
"value":"This would generally be omitted for Person resources."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"GroupCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Group.name"
},
"definition":{
"short":{
"value":"Label for Group"
},
"formal":{
"value":"A label assigned to the group for human identification and communication."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name[type=\"ST\"]"
}
}
]
}
},
{
"path":{
"value":"Group.quantity"
},
"definition":{
"short":{
"value":"Number of members"
},
"formal":{
"value":"A count of the number of resource instances that are part of the group."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./quantity"
}
}
]
}
},
{
"path":{
"value":"Group.characteristic"
},
"definition":{
"short":{
"value":"Trait of group members"
},
"formal":{
"value":"Identifies the traits shared by members of the group."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./playedRole[isNormalRole()]/participation[isNormalParticipation() and typeCode=\"SBJ\"]/act[isNormalAct and classCode=\"OBS\" and moodCode=\"EVN\"]"
}
}
]
}
},
{
"path":{
"value":"Group.characteristic.type"
},
"definition":{
"short":{
"value":"Kind of characteristic"
},
"formal":{
"value":"Identifies the kind of trait being asserted."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"GroupCharacteristicType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Group.characteristic.value[x]"
},
"definition":{
"short":{
"value":"Value held by characteristic"
},
"formal":{
"value":"The value of the trait that holds (or does not hold - see 'exclude') for members of the group."
},
"comments":{
"value":"For Range, it means members of the group have a value that falls somewhere within the specified range."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
},
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"boolean"
}
},
{
"code":{
"value":"Quantity"
}
},
{
"code":{
"value":"Range"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"GroupCharacteristicValue"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./value"
}
}
]
}
},
{
"path":{
"value":"Group.characteristic.exclude"
},
"definition":{
"short":{
"value":"Group includes or excludes"
},
"formal":{
"value":"If true, indicates the characteristic is one that is NOT held by members of the group."
},
"comments":{
"value":"This is labelled as \"Is Modifier\" because applications cannot wrongly include excluded members as included or vice versa."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./valueNegationInd"
}
}
]
}
},
{
"path":{
"value":"Group.member"
},
"definition":{
"short":{
"value":"Who is in group"
},
"formal":{
"value":"Identifies the resource instances that are members of the group."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|Device|Medication)"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"Group member type agreement"
},
"severity":{
"value":"error"
},
"human":{
"value":"Member resource types must agree with group type"
},
"xpath":{
"value":"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'))"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./scopedRole[isNormalRole() and classCode=\"MBR\"]/player"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"GroupType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/group-type"
}
}
},
{
"name":{
"value":"GroupCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Kind of particular resource"
}
},
{
"name":{
"value":"GroupCharacteristicValue"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Value of descriptive member characteristic"
}
},
{
"name":{
"value":"GroupCharacteristicType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"List of characteristics used to describe group members. E.g. gender, age, owner, location, etc."
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"group-definitions.htm#Group\"><b>Group<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"A unique business identifier for this group.\" class=\"dict\" href=\"group-definitions.htm#Group.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Unique id<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies the broad classification of the kind of resources the group includes.\" class=\"dict\" href=\"group-definitions.htm#Group.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"group-type.htm\">Group Classification<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.\" class=\"dict\" href=\"group-definitions.htm#Group.actual\"><b>actual<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Descriptive or actual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Provides a specific type of resource the group includes. E.g. "cow", "syringe", etc.\" class=\"dict\" href=\"group-definitions.htm#Group.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Kind of Group members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A label assigned to the group for human identification and communication.\" class=\"dict\" href=\"group-definitions.htm#Group.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Label for Group<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A count of the number of resource instances that are part of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.quantity\"><b>quantity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of members<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the traits shared by members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic\"><b>characteristic<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Trait of group members --><\/span>\r\n <<a title=\"Identifies the kind of trait being asserted.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Kind of characteristic<\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The value of the trait that holds (or does not hold - see 'exclude') for members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a><\/span> <span style=\"color: navy\">Value held by characteristic<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"If true, indicates the characteristic is one that is NOT held by members of the group (this element modifies the meaning of other elements)\" class=\"dict\" href=\"group-definitions.htm#Group.characteristic.exclude\"><span style=\"text-decoration: underline\"><b>exclude<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Group includes or excludes<\/span><span style=\"color: Gray\"> --><\/span>\r\n </characteristic>\r\n <<a title=\"Identifies the resource instances that are members of the group.\" class=\"dict\" href=\"group-definitions.htm#Group.member\"><b>member<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Can only have members if group is "actual"\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Who is in group<\/span><span style=\"color: Gray\"> --><\/span></member>\r\n</Group>\r\n<\/pre><\/div>"
},
{
"title":"\"imagingstudy\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/imagingstudy",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/imagingstudy.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy\"><b>ImagingStudy<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Date and Time the study took place.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the study was performed<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who the images are of.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who the images are of<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Formal identifier for the study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for the study (0020,000D)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Accession Number.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.accessionNo\"><b>accessionNo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Accession Number (0008,0050)<\/span><span style=\"color: Gray\"> --><\/span></accessionNo>\r\n <<a title=\"Other identifiers for the study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Other identifiers for the study (0020,0010)<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.modality\"><b>modality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"imaging-modality.htm\">All series.modality if actual acquisition modalities<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The requesting/referring physician.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.referrer\"><b>referrer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Referring physician (0008,0090)<\/span><span style=\"color: Gray\"> --><\/span></referrer>\r\n <<a title=\"Availability of study (online, offline or nearlnie).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.availability\"><b>availability<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.htm\">Instance Availability (0008,0056)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO-RS URI where Study is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Retrieve URI (0040,E010)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Number of Series in Study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.numberOfSeries\"><b>numberOfSeries<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Study Related Series (0020,1206)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Number of SOP Instances in Study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.numberOfInstances\"><b>numberOfInstances<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Study Related Instances (0020,1208)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Diagnoses etc provided with request.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.clinicalInformation\"><b>clinicalInformation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Diagnoses etc with request (0008,1080)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of procedure performed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.procedure\"><b>procedure<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Type of procedure performed (0008,1032)<\/span><span style=\"color: Gray\"> --><\/span></procedure>\r\n <<a title=\"Who read study and interpreted the images.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.interpreter\"><b>interpreter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who interpreted images (0008,1060)<\/span><span style=\"color: Gray\"> --><\/span></interpreter>\r\n <<a title=\"Institution-generated description or classification of the Study (component) performed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Institution-generated description (0008,1030)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Each study has one or more series of image instances.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series\"><b>series<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Each study has one or more series of instances --><\/span>\r\n <<a title=\"The number of this series in the overall sequence.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.number\"><b>number<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of this series in overall sequence (0020,0011)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The modality of this sequence.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.modality\"><b>modality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"modality.htm\">The modality of this sequence (0008,0060)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal identifier for this series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for this series (0020,000E)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A description of the series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">A description of the series (0008,103E)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Sequence that contains attributes from the.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.numberOfInstances\"><b>numberOfInstances<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Series Related Instances (0020,1209)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Availability of series (online, offline or nearlnie).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.availability\"><b>availability<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.htm\">Instance Availability (0008,0056)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO-RS URI where Series is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Retrieve URI (0040,E010)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Body part examined (Map from 0018,0015)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"When the series started.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the series started<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A single image taken from a patient.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance\"><b>instance<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A single instance taken from a patient (image or other) --><\/span>\r\n <<a title=\"The number of this image in the series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.number\"><b>number<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The number of this instance in the series (0020,0013)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal identifier for this image.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for this instance (0008,0018)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"DICOM Image type.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.sopclass\"><b>sopclass<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">DICOM class type (0008,0016)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of instance (0004,1430).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Type of instance (0004,1430)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description to be provided.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.title\"><b>title<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description to be provided<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO url where image is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">WADO / WADO-RS service where instance is available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A FHIR resource with content for this instance.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.attachment\"><b>attachment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">A FHIR resource with content for this instance<\/span><span style=\"color: Gray\"> --><\/span></attachment>\r\n </instance>\r\n </series>\r\n</ImagingStudy>\r\n<\/pre><\/div>"
},
"name":{
"value":"imagingstudy"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"ImagingStudy"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"ImagingStudy"
},
"definition":{
"short":{
"value":"A set of images produced in single study (one or more series of references images)"
},
"formal":{
"value":"Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"Reference IHE radiology TF vol 2 table 4.14.1"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.dateTime"
},
"definition":{
"short":{
"value":"When the study was performed"
},
"formal":{
"value":"Date and Time the study took place."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0020+0008,0030"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.subject"
},
"definition":{
"short":{
"value":"Who the images are of"
},
"formal":{
"value":"Who the images are of."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0010/*"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.uid"
},
"definition":{
"short":{
"value":"Formal identifier for the study (0020,000D)"
},
"formal":{
"value":"Formal identifier for the study."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"oid"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,000D"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.accessionNo"
},
"definition":{
"short":{
"value":"Accession Number (0008,0050)"
},
"formal":{
"value":"Accession Number."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0050"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.identifier"
},
"definition":{
"short":{
"value":"Other identifiers for the study (0020,0010)"
},
"formal":{
"value":"Other identifiers for the study."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,0010"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.modality"
},
"definition":{
"short":{
"value":"All series.modality if actual acquisition modalities"
},
"formal":{
"value":"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)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ImagingModality"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0061"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.referrer"
},
"definition":{
"short":{
"value":"Referring physician (0008,0090)"
},
"formal":{
"value":"The requesting/referring physician."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0090"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.availability"
},
"definition":{
"short":{
"value":"Instance Availability (0008,0056)"
},
"formal":{
"value":"Availability of study (online, offline or nearlnie)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"InstanceAvailability"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0056"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.url"
},
"definition":{
"short":{
"value":"Retrieve URI (0040,E010)"
},
"formal":{
"value":"WADO-RS URI where Study is available."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0040,E010"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.numberOfSeries"
},
"definition":{
"short":{
"value":"Number of Study Related Series (0020,1206)"
},
"formal":{
"value":"Number of Series in Study."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"(0020,1206)"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.numberOfInstances"
},
"definition":{
"short":{
"value":"Number of Study Related Instances (0020,1208)"
},
"formal":{
"value":"Number of SOP Instances in Study."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"(0020,1208)"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.clinicalInformation"
},
"definition":{
"short":{
"value":"Diagnoses etc with request (0008,1080)"
},
"formal":{
"value":"Diagnoses etc provided with request."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0040,1002"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.procedure"
},
"definition":{
"short":{
"value":"Type of procedure performed (0008,1032)"
},
"formal":{
"value":"Type of procedure performed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,1032"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.interpreter"
},
"definition":{
"short":{
"value":"Who interpreted images (0008,1060)"
},
"formal":{
"value":"Who read study and interpreted the images."
},
"comments":{
"value":"or is this 4008,010C?."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,1060"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.description"
},
"definition":{
"short":{
"value":"Institution-generated description (0008,1030)"
},
"formal":{
"value":"Institution-generated description or classification of the Study (component) performed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,1030"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series"
},
"definition":{
"short":{
"value":"Each study has one or more series of instances"
},
"formal":{
"value":"Each study has one or more series of image instances."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.series.number"
},
"definition":{
"short":{
"value":"Number of this series in overall sequence (0020,0011)"
},
"formal":{
"value":"The number of this series in the overall sequence."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,0011"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.modality"
},
"definition":{
"short":{
"value":"The modality of this sequence (0008,0060)"
},
"formal":{
"value":"The modality of this sequence."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Modality"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0060"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.uid"
},
"definition":{
"short":{
"value":"Formal identifier for this series (0020,000E)"
},
"formal":{
"value":"Formal identifier for this series."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"oid"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,000E"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.description"
},
"definition":{
"short":{
"value":"A description of the series (0008,103E)"
},
"formal":{
"value":"A description of the series."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,103E"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.numberOfInstances"
},
"definition":{
"short":{
"value":"Number of Series Related Instances (0020,1209)"
},
"formal":{
"value":"Sequence that contains attributes from the."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,1209"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.availability"
},
"definition":{
"short":{
"value":"Instance Availability (0008,0056)"
},
"formal":{
"value":"Availability of series (online, offline or nearlnie)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"InstanceAvailability"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0056"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.url"
},
"definition":{
"short":{
"value":"Retrieve URI (0040,E010)"
},
"formal":{
"value":"WADO-RS URI where Series is available."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0040,E010"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.bodySite"
},
"definition":{
"short":{
"value":"Body part examined (Map from 0018,0015)"
},
"formal":{
"value":"Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BodySite"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0018,0015"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.dateTime"
},
"definition":{
"short":{
"value":"When the series started"
},
"formal":{
"value":"When the series started."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.series.instance"
},
"definition":{
"short":{
"value":"A single instance taken from a patient (image or other)"
},
"formal":{
"value":"A single image taken from a patient."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.series.instance.number"
},
"definition":{
"short":{
"value":"The number of this instance in the series (0020,0013)"
},
"formal":{
"value":"The number of this image in the series."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0020,0013"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.instance.uid"
},
"definition":{
"short":{
"value":"Formal identifier for this instance (0008,0018)"
},
"formal":{
"value":"Formal identifier for this image."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"oid"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0018"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.instance.sopclass"
},
"definition":{
"short":{
"value":"DICOM class type (0008,0016)"
},
"formal":{
"value":"DICOM Image type."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"oid"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0016"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.instance.type"
},
"definition":{
"short":{
"value":"Type of instance (0004,1430)"
},
"formal":{
"value":"Type of instance (0004,1430)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0004,1430"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.instance.title"
},
"definition":{
"short":{
"value":"Description to be provided"
},
"formal":{
"value":"Description to be provided."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0070,0080 | 0040,A043 > 0008,0104 | 0042,0010 | 0008,0008"
}
}
]
}
},
{
"path":{
"value":"ImagingStudy.series.instance.url"
},
"definition":{
"short":{
"value":"WADO / WADO-RS service where instance is available"
},
"formal":{
"value":"WADO url where image is available."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImagingStudy.series.instance.attachment"
},
"definition":{
"short":{
"value":"A FHIR resource with content for this instance"
},
"formal":{
"value":"A FHIR resource with content for this instance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"ImagingModality"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/imaging-modality"
}
}
},
{
"name":{
"value":"InstanceAvailability"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/instance-availability"
}
}
},
{
"name":{
"value":"BodySite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/body-site"
}
}
},
{
"name":{
"value":"Modality"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/modality"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Manifest of a set of images produced in study. The set of images may include every image in the study, or it may be an incomplete sample, such as a list of key images.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy\"><b>ImagingStudy<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Date and Time the study took place.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the study was performed<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who the images are of.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who the images are of<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Formal identifier for the study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for the study (0020,000D)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Accession Number.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.accessionNo\"><b>accessionNo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Accession Number (0008,0050)<\/span><span style=\"color: Gray\"> --><\/span></accessionNo>\r\n <<a title=\"Other identifiers for the study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Other identifiers for the study (0020,0010)<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.modality\"><b>modality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"imaging-modality.htm\">All series.modality if actual acquisition modalities<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The requesting/referring physician.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.referrer\"><b>referrer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Referring physician (0008,0090)<\/span><span style=\"color: Gray\"> --><\/span></referrer>\r\n <<a title=\"Availability of study (online, offline or nearlnie).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.availability\"><b>availability<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.htm\">Instance Availability (0008,0056)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO-RS URI where Study is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Retrieve URI (0040,E010)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Number of Series in Study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.numberOfSeries\"><b>numberOfSeries<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Study Related Series (0020,1206)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Number of SOP Instances in Study.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.numberOfInstances\"><b>numberOfInstances<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Study Related Instances (0020,1208)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Diagnoses etc provided with request.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.clinicalInformation\"><b>clinicalInformation<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Diagnoses etc with request (0008,1080)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of procedure performed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.procedure\"><b>procedure<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Type of procedure performed (0008,1032)<\/span><span style=\"color: Gray\"> --><\/span></procedure>\r\n <<a title=\"Who read study and interpreted the images.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.interpreter\"><b>interpreter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who interpreted images (0008,1060)<\/span><span style=\"color: Gray\"> --><\/span></interpreter>\r\n <<a title=\"Institution-generated description or classification of the Study (component) performed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Institution-generated description (0008,1030)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Each study has one or more series of image instances.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series\"><b>series<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Each study has one or more series of instances --><\/span>\r\n <<a title=\"The number of this series in the overall sequence.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.number\"><b>number<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of this series in overall sequence (0020,0011)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The modality of this sequence.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.modality\"><b>modality<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"modality.htm\">The modality of this sequence (0008,0060)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal identifier for this series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for this series (0020,000E)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A description of the series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">A description of the series (0008,103E)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Sequence that contains attributes from the.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.numberOfInstances\"><b>numberOfInstances<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Number of Series Related Instances (0020,1209)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Availability of series (online, offline or nearlnie).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.availability\"><b>availability<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"instance-availability.htm\">Instance Availability (0008,0056)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO-RS URI where Series is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Retrieve URI (0040,E010)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Body part examined (Map from 0018,0015)<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"When the series started.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the series started<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A single image taken from a patient.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance\"><b>instance<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A single instance taken from a patient (image or other) --><\/span>\r\n <<a title=\"The number of this image in the series.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.number\"><b>number<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The number of this instance in the series (0020,0013)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal identifier for this image.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.uid\"><b>uid<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal identifier for this instance (0008,0018)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"DICOM Image type.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.sopclass\"><b>sopclass<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#oid\">oid<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">DICOM class type (0008,0016)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of instance (0004,1430).\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Type of instance (0004,1430)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description to be provided.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.title\"><b>title<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description to be provided<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"WADO url where image is available.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.url\"><b>url<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">WADO / WADO-RS service where instance is available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A FHIR resource with content for this instance.\" class=\"dict\" href=\"imagingstudy-definitions.htm#ImagingStudy.series.instance.attachment\"><b>attachment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">A FHIR resource with content for this instance<\/span><span style=\"color: Gray\"> --><\/span></attachment>\r\n </instance>\r\n </series>\r\n</ImagingStudy>\r\n<\/pre><\/div>"
},
{
"title":"\"immunization\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/immunization",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/immunization.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Immunization event information.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization\"><b>Immunization<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Date vaccine administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Vaccination Administration Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine that was administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccineType\"><b>vaccineType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Product Administered<\/span><span style=\"color: Gray\"> --><\/span></vaccineType>\r\n <<a title=\"The patient to whom the vaccine was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who this immunization was adminstered to<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Indicates if the vaccination was refused.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.refusedIndicator\"><b>refusedIndicator<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Resual Indicator<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"True if this administration was reported rather than directly administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reported\"><b>reported<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If self-reported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Clinician that administered the vaccine.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administering Provider Name<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Clinician who ordered the vaccination.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Vaccine Ordering Provider Name<\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"Name of vaccine manufacturer.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.manufacturer\"><b>manufacturer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Manufacturer<\/span><span style=\"color: Gray\"> --><\/span></manufacturer>\r\n <<a title=\"The service delivery location where the vaccine administration occurred.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Facility<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Lot number of the vaccine product.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.lotNumber\"><b>lotNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Lot Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date vaccine batch expires.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.expirationDate\"><b>expirationDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Expiration Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Body site where vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Site of Administration<\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"The path by which the vaccine product is taken into the body.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Route of Administration<\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"The quantity of vaccine product that was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.doseQuantity\"><b>doseQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Vaccine dosage<\/span><span style=\"color: Gray\"> --><\/span></doseQuantity>\r\n <<a title=\"Reasons why a vaccine was administered or refused.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation\"><b>explanation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Administration / Refusal Reasons --><\/span>\r\n <<a title=\"Reasons why a vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Administration Reasons<\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"Refusal or exemption reasons.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation.refusalReason\"><b>refusalReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Explanation of refusal / exemption<\/span><span style=\"color: Gray\"> --><\/span></refusalReason>\r\n </explanation>\r\n <<a title=\"Categorical data indicating that an adverse event is associated in time to an immunization.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction\"><b>reaction<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Details of a reaction that follows immunization --><\/span>\r\n <<a title=\"Date of reaction to the immunization.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reaction Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the reaction.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>|<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Details of the reaction<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n <<a title=\"Self-reported indicator.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.reported\"><b>reported<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Self-reported indicator<\/span><span style=\"color: Gray\"> --><\/span>\r\n </reaction>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol\"><b>vaccinationProtocol<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Vaccine Administration Protocol --><\/span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseSequence\"><b>doseSequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Dose Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Administration Protocol Description<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Protocol Authority<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.series\"><b>series<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Series<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The recommended number of doses to achieve immunity.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.seriesDoses\"><b>seriesDoses<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dose Number Recommendation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The targeted disease.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseTarget\"><b>doseTarget<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Targeted Disease<\/span><span style=\"color: Gray\"> --><\/span></doseTarget>\r\n <<a title=\"Indicates if the immunization event should "count" against the protocol.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseStatus\"><b>doseStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Dose Status<\/span><span style=\"color: Gray\"> --><\/span></doseStatus>\r\n <<a title=\"Provides an explanation as to why a immunization event should or should not count against the protocol.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseStatusReason\"><b>doseStatusReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Dose Status Reason<\/span><span style=\"color: Gray\"> --><\/span></doseStatusReason>\r\n </vaccinationProtocol>\r\n</Immunization>\r\n<\/pre><\/div>"
},
"name":{
"value":"immunization"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Immunization event information."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Immunization"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Immunization"
},
"definition":{
"short":{
"value":"Immunization event information"
},
"formal":{
"value":"Immunization event information."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"VXU_V04"
}
}
]
}
},
{
"path":{
"value":"Immunization.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.date"
},
"definition":{
"short":{
"value":"Vaccination Administration Date"
},
"formal":{
"value":"Date vaccine administered or was to be administered."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-3-date/time start of administration"
}
}
]
}
},
{
"path":{
"value":"Immunization.vaccineType"
},
"definition":{
"short":{
"value":"Vaccine Product Administered"
},
"formal":{
"value":"Vaccine that was administered or was to be administered."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"VaccineType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-5-administered code"
}
}
]
}
},
{
"path":{
"value":"Immunization.subject"
},
"definition":{
"short":{
"value":"Who this immunization was adminstered to"
},
"formal":{
"value":"The patient to whom the vaccine was to be administered."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".partipication[ttypeCode=].role"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"Immunization.refusedIndicator"
},
"definition":{
"short":{
"value":"Resual Indicator"
},
"formal":{
"value":"Indicates if the vaccination was refused."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.reported"
},
"definition":{
"short":{
"value":"If self-reported"
},
"formal":{
"value":"True if this administration was reported rather than directly administered."
},
"comments":{
"value":"May need source of reported info (e.g. parent), but leave out for now."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-9"
}
}
]
}
},
{
"path":{
"value":"Immunization.performer"
},
"definition":{
"short":{
"value":"Vaccine Administering Provider Name"
},
"formal":{
"value":"Clinician that administered the vaccine."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-10-administering provider"
}
}
]
}
},
{
"path":{
"value":"Immunization.requester"
},
"definition":{
"short":{
"value":"Vaccine Ordering Provider Name"
},
"formal":{
"value":"Clinician who ordered the vaccination."
},
"comments":{
"value":"other participants - delegate to Provenance resource."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-12-ordering provider"
}
}
]
}
},
{
"path":{
"value":"Immunization.manufacturer"
},
"definition":{
"short":{
"value":"Vaccine Manufacturer"
},
"formal":{
"value":"Name of vaccine manufacturer."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-17-substance manufacturer name"
}
}
]
}
},
{
"path":{
"value":"Immunization.location"
},
"definition":{
"short":{
"value":"Vaccine Administration Facility"
},
"formal":{
"value":"The service delivery location where the vaccine administration occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-27-administered-at (or RXA-11-administered-at location, deprecated as of v2.7)"
}
}
]
}
},
{
"path":{
"value":"Immunization.lotNumber"
},
"definition":{
"short":{
"value":"Vaccine Lot Number"
},
"formal":{
"value":"Lot number of the vaccine product."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-15-substance lot number"
}
}
]
}
},
{
"path":{
"value":"Immunization.expirationDate"
},
"definition":{
"short":{
"value":"Vaccine Expiration Date"
},
"formal":{
"value":"Date vaccine batch expires."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-16-substance expiration date"
}
}
]
}
},
{
"path":{
"value":"Immunization.site"
},
"definition":{
"short":{
"value":"Vaccine Site of Administration"
},
"formal":{
"value":"Body site where vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ImmunizationSite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-2-administration site"
}
}
]
}
},
{
"path":{
"value":"Immunization.route"
},
"definition":{
"short":{
"value":"Vaccine Route of Administration"
},
"formal":{
"value":"The path by which the vaccine product is taken into the body."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ImmunizationRoute"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-1-route"
}
}
]
}
},
{
"path":{
"value":"Immunization.doseQuantity"
},
"definition":{
"short":{
"value":"Vaccine dosage"
},
"formal":{
"value":"The quantity of vaccine product that was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-6-administered amount / RXA-7.1-administered units.code"
}
}
]
}
},
{
"path":{
"value":"Immunization.explanation"
},
"definition":{
"short":{
"value":"Administration / Refusal Reasons"
},
"formal":{
"value":"Reasons why a vaccine was administered or refused."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.explanation.reason"
},
"definition":{
"short":{
"value":"Administration Reasons"
},
"formal":{
"value":"Reasons why a vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ActImmunizationReason"
}
}
},
{
"path":{
"value":"Immunization.explanation.refusalReason"
},
"definition":{
"short":{
"value":"Explanation of refusal / exemption"
},
"formal":{
"value":"Refusal or exemption reasons."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ActNoImmunizationReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-18"
}
}
]
}
},
{
"path":{
"value":"Immunization.reaction"
},
"definition":{
"short":{
"value":"Details of a reaction that follows immunization"
},
"formal":{
"value":"Categorical data indicating that an adverse event is associated in time to an immunization."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-3"
}
}
]
}
},
{
"path":{
"value":"Immunization.reaction.date"
},
"definition":{
"short":{
"value":"Reaction Date"
},
"formal":{
"value":"Date of reaction to the immunization."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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)"
}
}
]
}
},
{
"path":{
"value":"Immunization.reaction.detail"
},
"definition":{
"short":{
"value":"Details of the reaction"
},
"formal":{
"value":"Details of the reaction."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(AdverseReaction|Observation)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5"
}
}
]
}
},
{
"path":{
"value":"Immunization.reaction.reported"
},
"definition":{
"short":{
"value":"Self-reported indicator"
},
"formal":{
"value":"Self-reported indicator."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(no such concept seems to exist for allergy/adverse reaction in V2.x)"
}
}
]
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol"
},
"formal":{
"value":"Contains information about the protocol under which the vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(V2.x doesn't seem to provide for this)"
}
}
]
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.doseSequence"
},
"definition":{
"short":{
"value":"Dose Number"
},
"formal":{
"value":"Nominal position in a series."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.description"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol Description"
},
"formal":{
"value":"Contains the description about the protocol under which the vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.authority"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol Authority"
},
"formal":{
"value":"Indicates the authority who published the protocol? E.g. ACIP."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.series"
},
"definition":{
"short":{
"value":"Vaccine Series"
},
"formal":{
"value":"One possible path to achieve presumed immunity against a disease - within the context of an authority."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.seriesDoses"
},
"definition":{
"short":{
"value":"Dose Number Recommendation"
},
"formal":{
"value":"The recommended number of doses to achieve immunity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.doseTarget"
},
"definition":{
"short":{
"value":"Targeted Disease"
},
"formal":{
"value":"The targeted disease."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"VaccinationProtocolDoseTarget"
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.doseStatus"
},
"definition":{
"short":{
"value":"Dose Status"
},
"formal":{
"value":"Indicates if the immunization event should \"count\" against the protocol."
},
"comments":{
"value":"May need to differentiate between status declarations by a provider vs. a CDS engine."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"VaccinationProtocolDoseStatus"
}
}
},
{
"path":{
"value":"Immunization.vaccinationProtocol.doseStatusReason"
},
"definition":{
"short":{
"value":"Dose Status Reason"
},
"formal":{
"value":"Provides an explanation as to why a immunization event should or should not count against the protocol."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"VaccinationProtocolDoseStatusReason"
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"VaccinationProtocolDoseTarget"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The disease target of the vaccination protocol"
}
},
{
"name":{
"value":"ActImmunizationReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The reason why a vaccine was administered"
}
},
{
"name":{
"value":"ImmunizationSite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The site at which the vaccine was administered"
}
},
{
"name":{
"value":"ImmunizationRoute"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The route by which the vaccine was administered"
}
},
{
"name":{
"value":"VaccinationProtocolDoseStatusReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The reason for the determining if a vaccination should count or why vaccination should not count."
}
},
{
"name":{
"value":"ActNoImmunizationReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The reason why a vaccine administration was refused"
}
},
{
"name":{
"value":"VaccineType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The type of vaccine administered"
}
},
{
"name":{
"value":"VaccinationProtocolDoseStatus"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The status of the vaccination protocol (i.e. should this count)"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Immunization event information.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization\"><b>Immunization<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Date vaccine administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Vaccination Administration Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine that was administered or was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccineType\"><b>vaccineType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Product Administered<\/span><span style=\"color: Gray\"> --><\/span></vaccineType>\r\n <<a title=\"The patient to whom the vaccine was to be administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who this immunization was adminstered to<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Indicates if the vaccination was refused.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.refusedIndicator\"><b>refusedIndicator<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Resual Indicator<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"True if this administration was reported rather than directly administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reported\"><b>reported<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If self-reported<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Clinician that administered the vaccine.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administering Provider Name<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Clinician who ordered the vaccination.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Vaccine Ordering Provider Name<\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"Name of vaccine manufacturer.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.manufacturer\"><b>manufacturer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Manufacturer<\/span><span style=\"color: Gray\"> --><\/span></manufacturer>\r\n <<a title=\"The service delivery location where the vaccine administration occurred.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Facility<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"Lot number of the vaccine product.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.lotNumber\"><b>lotNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Lot Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Date vaccine batch expires.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.expirationDate\"><b>expirationDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Expiration Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Body site where vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Site of Administration<\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"The path by which the vaccine product is taken into the body.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine Route of Administration<\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"The quantity of vaccine product that was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.doseQuantity\"><b>doseQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Vaccine dosage<\/span><span style=\"color: Gray\"> --><\/span></doseQuantity>\r\n <<a title=\"Reasons why a vaccine was administered or refused.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation\"><b>explanation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Administration / Refusal Reasons --><\/span>\r\n <<a title=\"Reasons why a vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Administration Reasons<\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"Refusal or exemption reasons.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.explanation.refusalReason\"><b>refusalReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Explanation of refusal / exemption<\/span><span style=\"color: Gray\"> --><\/span></refusalReason>\r\n </explanation>\r\n <<a title=\"Categorical data indicating that an adverse event is associated in time to an immunization.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction\"><b>reaction<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Details of a reaction that follows immunization --><\/span>\r\n <<a title=\"Date of reaction to the immunization.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reaction Date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the reaction.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>|<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Details of the reaction<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n <<a title=\"Self-reported indicator.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.reaction.reported\"><b>reported<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Self-reported indicator<\/span><span style=\"color: Gray\"> --><\/span>\r\n </reaction>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol\"><b>vaccinationProtocol<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Vaccine Administration Protocol --><\/span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseSequence\"><b>doseSequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Dose Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Administration Protocol Description<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Protocol Authority<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.series\"><b>series<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Series<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The recommended number of doses to achieve immunity.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.seriesDoses\"><b>seriesDoses<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dose Number Recommendation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The targeted disease.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseTarget\"><b>doseTarget<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Targeted Disease<\/span><span style=\"color: Gray\"> --><\/span></doseTarget>\r\n <<a title=\"Indicates if the immunization event should "count" against the protocol.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseStatus\"><b>doseStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Dose Status<\/span><span style=\"color: Gray\"> --><\/span></doseStatus>\r\n <<a title=\"Provides an explanation as to why a immunization event should or should not count against the protocol.\" class=\"dict\" href=\"immunization-definitions.htm#Immunization.vaccinationProtocol.doseStatusReason\"><b>doseStatusReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Dose Status Reason<\/span><span style=\"color: Gray\"> --><\/span></doseStatusReason>\r\n </vaccinationProtocol>\r\n</Immunization>\r\n<\/pre><\/div>"
},
{
"title":"\"immunizationprofile\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/immunizationprofile",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/immunizationprofile.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A patient's point-of-time immunization status and recommendation with optional supporting justification.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile\"><b>ImmunizationProfile<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The patient who is the subject of the profile.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who this profile is for<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Vaccine administration recommendations.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation\"><b>recommendation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Vaccine administration recommendations --><\/span>\r\n <<a title=\"The date of the immunization recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.recommendationDate\"><b>recommendationDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Recommendation date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine that pertains to the recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.vaccineType\"><b>vaccineType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine that pertains to the recommendation<\/span><span style=\"color: Gray\"> --><\/span></vaccineType>\r\n <<a title=\"Recommended dose number.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.doseNumber\"><b>doseNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Recommended dose number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine administration status.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.forecastStatus\"><b>forecastStatus<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"immunization-forecast-status.htm\">Vaccine administration status<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine date recommentations - e.g. earliest date to administer, latest date to administer, etc.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion\"><b>dateCriterion<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Pertinent dates --><\/span>\r\n <<a title=\"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Date classification of recommendation<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Date recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date recommendation<\/span><span style=\"color: Gray\"> --><\/span>\r\n </dateCriterion>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol\"><b>protocol<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Vaccine Administration Protocol --><\/span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.doseSequence\"><b>doseSequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dose Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Administration Protocol Description<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Protocol Authority<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.series\"><b>series<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Series<\/span><span style=\"color: Gray\"> --><\/span>\r\n </protocol>\r\n <<a title=\"Immunization event history that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingImmunization\"><b>supportingImmunization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"immunization.htm#Immunization\">Immunization<\/a>)<\/span> <span style=\"color: navy\">Supporting Immunization<\/span><span style=\"color: Gray\"> --><\/span></supportingImmunization>\r\n <<a title=\"Adverse event report information that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport\"><b>supportingAdverseEventReport<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supporting adverse event report --><\/span>\r\n <<a title=\"Unique identifier of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\">Adverse event report identifier<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Advers event report classification.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reportType\"><b>reportType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Adverse event report classification<\/span><span style=\"color: Gray\"> --><\/span></reportType>\r\n <<a title=\"The date of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reportDate\"><b>reportDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Adverse event report date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The content of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Adverse event report text<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The documented reaction described in the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reaction\"><b>reaction<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>)<\/span> <span style=\"color: navy\">Documented reaction<\/span><span style=\"color: Gray\"> --><\/span></reaction>\r\n </supportingAdverseEventReport>\r\n <<a title=\"Patient observation that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingPatientObservation\"><b>supportingPatientObservation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Supporting Patient Observation<\/span><span style=\"color: Gray\"> --><\/span></supportingPatientObservation>\r\n </recommendation>\r\n</ImmunizationProfile>\r\n<\/pre><\/div>"
},
"name":{
"value":"immunizationprofile"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A patient's point-of-time immunization status and recommendation with optional supporting justification."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"ImmunizationProfile"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"ImmunizationProfile"
},
"definition":{
"short":{
"value":"An immunization profile"
},
"formal":{
"value":"A patient's point-of-time immunization status and recommendation with optional supporting justification."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"VXU_V04"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.subject"
},
"definition":{
"short":{
"value":"Who this profile is for"
},
"formal":{
"value":"The patient who is the subject of the profile."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".partipication[ttypeCode=].role"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation"
},
"definition":{
"short":{
"value":"Vaccine administration recommendations"
},
"formal":{
"value":"Vaccine administration recommendations."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.recommendationDate"
},
"definition":{
"short":{
"value":"Recommendation date"
},
"formal":{
"value":"The date of the immunization recommendation."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-15-date/time of the observation"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.vaccineType"
},
"definition":{
"short":{
"value":"Vaccine that pertains to the recommendation"
},
"formal":{
"value":"Vaccine that pertains to the recommendation."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"VaccineType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier e { 30956-7 | 38890-0 }"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.doseNumber"
},
"definition":{
"short":{
"value":"Recommended dose number"
},
"formal":{
"value":"Recommended dose number."
},
"comments":{
"value":"May need other dose concepts such as administered vs. valid."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.forecastStatus"
},
"definition":{
"short":{
"value":"Vaccine administration status"
},
"formal":{
"value":"Vaccine administration status."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ImmunizationForecastStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 59783-1"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.dateCriterion"
},
"definition":{
"short":{
"value":"Pertinent dates"
},
"formal":{
"value":"Vaccine date recommentations - e.g. earliest date to administer, latest date to administer, etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.dateCriterion.code"
},
"definition":{
"short":{
"value":"Date classification of recommendation"
},
"formal":{
"value":"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ImmunizationProfileDateCriterion"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-3-observation identifier"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.dateCriterion.value"
},
"definition":{
"short":{
"value":"Date recommendation"
},
"formal":{
"value":"Date recommendation."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.protocol"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol"
},
"formal":{
"value":"Contains information about the protocol under which the vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.protocol.doseSequence"
},
"definition":{
"short":{
"value":"Dose Number"
},
"formal":{
"value":"Nominal position in a series."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 30973-2"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.protocol.description"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol Description"
},
"formal":{
"value":"Contains the description about the protocol under which the vaccine was administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 30956-7"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.protocol.authority"
},
"definition":{
"short":{
"value":"Vaccine Administration Protocol Authority"
},
"formal":{
"value":"Indicates the authority who published the protocol? E.g. ACIP."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 59779-9"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.protocol.series"
},
"definition":{
"short":{
"value":"Vaccine Series"
},
"formal":{
"value":"One possible path to achieve presumed immunity against a disease - within the context of an authority."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-5-administered code"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingImmunization"
},
"definition":{
"short":{
"value":"Supporting Immunization"
},
"formal":{
"value":"Immunization event history that supports the status and recommendation."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Immunization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"? No clear way to associate in V2.x or IG"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport"
},
"definition":{
"short":{
"value":"Supporting adverse event report"
},
"formal":{
"value":"Adverse event report information that supports the status and recommendation."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport.identifier"
},
"definition":{
"short":{
"value":"Adverse event report identifier"
},
"formal":{
"value":"Unique identifier of the adverse event report."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport.reportType"
},
"definition":{
"short":{
"value":"Adverse event report classification"
},
"formal":{
"value":"Advers event report classification."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdverseEventReportType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"[tbd] : OBX-3-observation identifier = 31044-1 (seems to be only one LOINC code for 'reaction' -> only one AdverseEventReportType?)"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport.reportDate"
},
"definition":{
"short":{
"value":"Adverse event report date"
},
"formal":{
"value":"The date of the adverse event report."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-15-date/time of the observation"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport.text"
},
"definition":{
"short":{
"value":"Adverse event report text"
},
"formal":{
"value":"The content of the adverse event report."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5-observation value : OBX-3-observation identifier = 31044-1"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingAdverseEventReport.reaction"
},
"definition":{
"short":{
"value":"Documented reaction"
},
"formal":{
"value":"The documented reaction described in the adverse event report."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(AdverseReaction)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"IAM/IAR"
}
}
]
}
},
{
"path":{
"value":"ImmunizationProfile.recommendation.supportingPatientObservation"
},
"definition":{
"short":{
"value":"Supporting Patient Observation"
},
"formal":{
"value":"Patient observation that supports the status and recommendation."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Observation)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ImmunizationProfileDateCriterion"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)"
}
},
{
"name":{
"value":"ImmunizationForecastStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/immunization-forecast-status"
}
}
},
{
"name":{
"value":"AdverseEventReportType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"Classifies an adverse event report"
}
},
{
"name":{
"value":"VaccineType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"The type of vaccine administered"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A patient's point-of-time immunization status and recommendation with optional supporting justification.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile\"><b>ImmunizationProfile<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The patient who is the subject of the profile.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Who this profile is for<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Vaccine administration recommendations.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation\"><b>recommendation<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> Vaccine administration recommendations --><\/span>\r\n <<a title=\"The date of the immunization recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.recommendationDate\"><b>recommendationDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Recommendation date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine that pertains to the recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.vaccineType\"><b>vaccineType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Vaccine that pertains to the recommendation<\/span><span style=\"color: Gray\"> --><\/span></vaccineType>\r\n <<a title=\"Recommended dose number.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.doseNumber\"><b>doseNumber<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Recommended dose number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine administration status.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.forecastStatus\"><b>forecastStatus<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"immunization-forecast-status.htm\">Vaccine administration status<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Vaccine date recommentations - e.g. earliest date to administer, latest date to administer, etc.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion\"><b>dateCriterion<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Pertinent dates --><\/span>\r\n <<a title=\"Date classification of recommendation - e.g. earliest date to give, latest date to give, etc.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Date classification of recommendation<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Date recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.dateCriterion.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date recommendation<\/span><span style=\"color: Gray\"> --><\/span>\r\n </dateCriterion>\r\n <<a title=\"Contains information about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol\"><b>protocol<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Vaccine Administration Protocol --><\/span>\r\n <<a title=\"Nominal position in a series.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.doseSequence\"><b>doseSequence<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dose Number<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contains the description about the protocol under which the vaccine was administered.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Administration Protocol Description<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the authority who published the protocol? E.g. ACIP.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Vaccine Administration Protocol Authority<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"One possible path to achieve presumed immunity against a disease - within the context of an authority.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.protocol.series\"><b>series<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Vaccine Series<\/span><span style=\"color: Gray\"> --><\/span>\r\n </protocol>\r\n <<a title=\"Immunization event history that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingImmunization\"><b>supportingImmunization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"immunization.htm#Immunization\">Immunization<\/a>)<\/span> <span style=\"color: navy\">Supporting Immunization<\/span><span style=\"color: Gray\"> --><\/span></supportingImmunization>\r\n <<a title=\"Adverse event report information that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport\"><b>supportingAdverseEventReport<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supporting adverse event report --><\/span>\r\n <<a title=\"Unique identifier of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\">Adverse event report identifier<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Advers event report classification.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reportType\"><b>reportType<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Adverse event report classification<\/span><span style=\"color: Gray\"> --><\/span></reportType>\r\n <<a title=\"The date of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reportDate\"><b>reportDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Adverse event report date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The content of the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Adverse event report text<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The documented reaction described in the adverse event report.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingAdverseEventReport.reaction\"><b>reaction<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"adversereaction.htm#AdverseReaction\">AdverseReaction<\/a>)<\/span> <span style=\"color: navy\">Documented reaction<\/span><span style=\"color: Gray\"> --><\/span></reaction>\r\n </supportingAdverseEventReport>\r\n <<a title=\"Patient observation that supports the status and recommendation.\" class=\"dict\" href=\"immunizationprofile-definitions.htm#ImmunizationProfile.recommendation.supportingPatientObservation\"><b>supportingPatientObservation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"observation.htm#Observation\">Observation<\/a>)<\/span> <span style=\"color: navy\">Supporting Patient Observation<\/span><span style=\"color: Gray\"> --><\/span></supportingPatientObservation>\r\n </recommendation>\r\n</ImmunizationProfile>\r\n<\/pre><\/div>"
},
{
"title":"\"list\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/list",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/list.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A set of information summarized from a list of other resources.\" class=\"dict\" href=\"list-definitions.htm#List\"><b>List<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"This code defines the purpose of the list - why it was created.\" class=\"dict\" href=\"list-definitions.htm#List.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-example-codes.htm\">What the purpose of this list is<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The entity responsible for deciding what the contents of the list were.\" class=\"dict\" href=\"list-definitions.htm#List.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Source of the list<\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"The date that the list was prepared.\" class=\"dict\" href=\"list-definitions.htm#List.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the list was prepared<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether items in the list have a meaningful order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.ordered\"><span style=\"text-decoration: underline\"><b>ordered<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether items in the list have a meaningful order<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How this list was prepared - whether it is a working list that is suitable for being maintained in 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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.mode\"><span style=\"text-decoration: underline\"><b>mode<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"list-mode.htm\">working | snapshot | changes<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Entries in this list.\" class=\"dict\" href=\"list-definitions.htm#List.entry\"><b>entry<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Entries in the list --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"list-definitions.htm#List.entry.flag\"><b>flag<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-item-flag.htm\">Workflow information about this item<\/a><\/span><span style=\"color: Gray\"> --><\/span></flag>\r\n <<a title=\"True if this item is marked as deleted in the list (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.entry.deleted\"><span style=\"text-decoration: underline\"><b>deleted<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: The deleted flag can only be used if the mode of the list is "changes"\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this item is actually marked as deleted<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When this item was added to the list.\" class=\"dict\" href=\"list-definitions.htm#List.entry.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When item added to list<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A reference to the actual resource from which data was derived.\" class=\"dict\" href=\"list-definitions.htm#List.entry.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Actual entry<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n </entry>\r\n <<a title=\"If the list is empty, why the list is empty.\" class=\"dict\" href=\"list-definitions.htm#List.emptyReason\"><b>emptyReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-empty-reason.htm\">Why list is empty<\/a><\/span><span style=\"color: Gray\"> --><\/span></emptyReason>\r\n</List>\r\n<\/pre><\/div>"
},
"name":{
"value":"list"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A set of information summarized from a list of other resources."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"List"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"List"
},
"definition":{
"short":{
"value":"Information summarized from a list of other resources"
},
"formal":{
"value":"A set of information summarized from a list of other resources."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"Deleted Rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"The deleted flag can only be used if the mode of the list is \"changes\""
},
"xpath":{
"value":"(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"No emptyReason if list is not empty"
},
"severity":{
"value":"error"
},
"human":{
"value":"A list can only have an emptyReason if it is empty"
},
"xpath":{
"value":"not(exists(f:emptyReason) and exists(f:entry))"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Act[normalAct() and subsumes(ActClass#_ActClassRecordOrganizer, classCode) and moodCode=EVN]"
}
}
]
}
},
{
"path":{
"value":"List.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"List.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"List.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"List.code"
},
"definition":{
"short":{
"value":"What the purpose of this list is"
},
"formal":{
"value":"This code defines the purpose of the list - why it was created."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ListCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".code"
}
}
]
}
},
{
"path":{
"value":"List.source"
},
"definition":{
"short":{
"value":"Source of the list"
},
"formal":{
"value":"The entity responsible for deciding what the contents of the list were."
},
"comments":{
"value":"The primary and important source is the entity that made the decisions what items are in the list. This may be software or user."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(.participation[isNormalParticipation() and typeCode=ParticipationTypeCode#AUT]/role[isNormalRole() and classCode=REL]/player[isNormalEntity() and classCode=PSN and determinerCode=INST]\n\nor\n\n.participation[isNormalParticipation() and typeCode=ParticipationTypeCode#AUT]/role[isNormalRole() and classCode=ASSIGNED][player[classCode!=DEV and determinerCode=INST and isNormalEntity()]]\n\nor\n\n.participation[isNormalParticipation() and typeCode=ParticipationTypeCode#AUT]/role[isNormalRole() and classCode=ASSIGNED]/player[classCode=DEV and determinerCode=INST and isNormalEntity()])"
}
}
]
}
},
{
"path":{
"value":"List.date"
},
"definition":{
"short":{
"value":"When the list was prepared"
},
"formal":{
"value":"The date that the list was prepared."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".participation[isNormalParticipation() and typeCode=ParticipationTypeCode#AUT]/time[type=TS]"
}
}
]
}
},
{
"path":{
"value":"List.ordered"
},
"definition":{
"short":{
"value":"Whether items in the list have a meaningful order"
},
"formal":{
"value":"Whether items in the list have a meaningful order."
},
"comments":{
"value":"Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. This is marked as \"is modified\" because whether the list is ordered or not has may change how the results are processed or displayed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"count(distinct-values(./outboundRelationship[typeCode=COMP and isNormalActRelationship()]/sequenceNumber))>1 \nor \ncount(./participation[isNormalParticipation() and typeCode=SBJ]/sequenceNumber))>1"
}
}
]
}
},
{
"path":{
"value":"List.mode"
},
"definition":{
"short":{
"value":"working | snapshot | changes"
},
"formal":{
"value":"How this list was prepared - whether it is a working list that is suitable for being maintained in 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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ListMode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"??"
}
}
]
}
},
{
"path":{
"value":"List.entry"
},
"definition":{
"short":{
"value":"Entries in the list"
},
"formal":{
"value":"Entries in this list."
},
"comments":{
"value":"If there are no entries in the list, an emptyReason SHOULD be provided."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=COMP and isNormalActRelationship()]\nor \n./participation[isNormalParticipation() and typeCode=SBJ"
}
}
]
}
},
{
"path":{
"value":"List.entry.flag"
},
"definition":{
"short":{
"value":"Workflow information about this item"
},
"formal":{
"value":"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":{
"value":"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 must be true. Deleted can only be used if the List.mode is \"changes\"."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ListItemFlag"
}
}
},
{
"path":{
"value":"List.entry.deleted"
},
"definition":{
"short":{
"value":"If this item is actually marked as deleted"
},
"formal":{
"value":"True if this item is marked as deleted in the list."
},
"comments":{
"value":"If the flag means that the entry has actually been deleted from the list, the deleted element must 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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"added: ./updateMode=(\"A\",\"AR\")\n\nretained: ./updateMode=\"NC\"\n\nupdated: ./updateMode=\"R\"\n\ndeleted: ./updateMode=\"D\""
}
}
]
}
},
{
"path":{
"value":"List.entry.date"
},
"definition":{
"short":{
"value":"When item added to list"
},
"formal":{
"value":"When this item was added to the list."
},
"comments":{
"value":"This is only useful and meaningful when the mode is \"working\"."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"List.entry.item"
},
"definition":{
"short":{
"value":"Actual entry"
},
"formal":{
"value":"A reference to the actual resource from which data was derived."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./target\nor\n./role\nor\n./role/entity"
}
}
]
}
},
{
"path":{
"value":"List.emptyReason"
},
"definition":{
"short":{
"value":"Why list is empty"
},
"formal":{
"value":"If the list is empty, why the list is empty."
},
"comments":{
"value":"The various reasons for an empty list make a significant interpretation to its interpretation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ListEmptyReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./inboundRelationship[typeCode=SUBJ and isNormalActRelationship and subsumes(ListEmptyReason, code)]/value[type=CD]"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ListItemFlag"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/list-item-flag"
}
}
},
{
"name":{
"value":"ListMode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/list-mode"
}
}
},
{
"name":{
"value":"ListCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/list-example-codes"
}
}
},
{
"name":{
"value":"ListEmptyReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/list-empty-reason"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A set of information summarized from a list of other resources.\" class=\"dict\" href=\"list-definitions.htm#List\"><b>List<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"This code defines the purpose of the list - why it was created.\" class=\"dict\" href=\"list-definitions.htm#List.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-example-codes.htm\">What the purpose of this list is<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The entity responsible for deciding what the contents of the list were.\" class=\"dict\" href=\"list-definitions.htm#List.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Source of the list<\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"The date that the list was prepared.\" class=\"dict\" href=\"list-definitions.htm#List.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the list was prepared<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether items in the list have a meaningful order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.ordered\"><span style=\"text-decoration: underline\"><b>ordered<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether items in the list have a meaningful order<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"How this list was prepared - whether it is a working list that is suitable for being maintained in 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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.mode\"><span style=\"text-decoration: underline\"><b>mode<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"list-mode.htm\">working | snapshot | changes<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Entries in this list.\" class=\"dict\" href=\"list-definitions.htm#List.entry\"><b>entry<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Entries in the list --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"list-definitions.htm#List.entry.flag\"><b>flag<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-item-flag.htm\">Workflow information about this item<\/a><\/span><span style=\"color: Gray\"> --><\/span></flag>\r\n <<a title=\"True if this item is marked as deleted in the list (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.htm#List.entry.deleted\"><span style=\"text-decoration: underline\"><b>deleted<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: The deleted flag can only be used if the mode of the list is "changes"\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If this item is actually marked as deleted<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"When this item was added to the list.\" class=\"dict\" href=\"list-definitions.htm#List.entry.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When item added to list<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A reference to the actual resource from which data was derived.\" class=\"dict\" href=\"list-definitions.htm#List.entry.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Actual entry<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n </entry>\r\n <<a title=\"If the list is empty, why the list is empty.\" class=\"dict\" href=\"list-definitions.htm#List.emptyReason\"><b>emptyReason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-empty-reason.htm\">Why list is empty<\/a><\/span><span style=\"color: Gray\"> --><\/span></emptyReason>\r\n</List>\r\n<\/pre><\/div>"
},
{
"title":"\"location\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/location",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/location.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Contact details and position information for a physical place that may be visited and where healthcare resources and participants may be found or contained, accommodated, or stored.\" class=\"dict\" href=\"location-definitions.htm#Location\"><b>Location<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Name of the location which identifies it to its users.\" class=\"dict\" href=\"location-definitions.htm#Location.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the location<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description of the Location, which helps in finding or referencing the place.\" class=\"dict\" href=\"location-definitions.htm#Location.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the Location<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Classification of the location.\" class=\"dict\" href=\"location-definitions.htm#Location.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-location-type.htm\">Classification of the location<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The contact details of the main communication devices present at the location.\" class=\"dict\" href=\"location-definitions.htm#Location.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact details of the location<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Physical location.\" class=\"dict\" href=\"location-definitions.htm#Location.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Physical location<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).\" class=\"dict\" href=\"location-definitions.htm#Location.position\"><b>position<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> The absolute geographic location --><\/span>\r\n <<a title=\"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.longitude\"><b>longitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Longitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.latitude\"><b>latitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Latitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.altitude\"><b>altitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Altitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n </position>\r\n <<a title=\"The organization that provides services at the location.\" class=\"dict\" href=\"location-definitions.htm#Location.provider\"><b>provider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The organization that provides services at the location<\/span><span style=\"color: Gray\"> --><\/span></provider>\r\n <<a title=\"Whether the location is still used to provide services (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.htm#Location.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether the location is still used to provide services<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Another Location which this Location is physically inside of.\" class=\"dict\" href=\"location-definitions.htm#Location.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Another Location which this Location is physically inside of<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n</Location>\r\n<\/pre><\/div>"
},
"name":{
"value":"location"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Contact details and position information for a physical place that may be visited and where healthcare resources and participants may be found or contained, accommodated, or stored."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Location"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Location"
},
"definition":{
"short":{
"value":"Contact details and position information for a physical place"
},
"formal":{
"value":"Contact details and position information for a physical place that may be visited and where healthcare resources and participants may be found or contained, accommodated, or stored."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"ServiceDeliveryLocation"
}
}
]
}
},
{
"path":{
"value":"Location.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.name"
},
"definition":{
"short":{
"value":"Name of the location"
},
"formal":{
"value":"Name of the location which identifies it to its users."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./location/name"
}
}
]
}
},
{
"path":{
"value":"Location.description"
},
"definition":{
"short":{
"value":"Description of the Location"
},
"formal":{
"value":"Description of the Location, which helps in finding or referencing the place."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./location/desc"
}
}
]
}
},
{
"path":{
"value":"Location.type"
},
"definition":{
"short":{
"value":"Classification of the location"
},
"formal":{
"value":"Classification of the location."
},
"comments":{
"value":"There are many ways by which locations can be classified, so this element may be repeated."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"LocationType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Location.telecom"
},
"definition":{
"short":{
"value":"Contact details of the location"
},
"formal":{
"value":"The contact details of the main communication devices present at the location."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./location/telecom"
}
}
]
}
},
{
"path":{
"value":"Location.address"
},
"definition":{
"short":{
"value":"Physical location"
},
"formal":{
"value":"Physical location."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./location/addr"
}
}
]
}
},
{
"path":{
"value":"Location.position"
},
"definition":{
"short":{
"value":"The absolute geographic location"
},
"formal":{
"value":"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.position.longitude"
},
"definition":{
"short":{
"value":"Longitude"
},
"formal":{
"value":"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"decimal"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.position.latitude"
},
"definition":{
"short":{
"value":"Latitude"
},
"formal":{
"value":"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"decimal"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.position.altitude"
},
"definition":{
"short":{
"value":"Altitude"
},
"formal":{
"value":"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"decimal"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Location.provider"
},
"definition":{
"short":{
"value":"The organization that provides services at the location"
},
"formal":{
"value":"The organization that provides services at the location."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./servicePractitionerOrganization"
}
}
]
}
},
{
"path":{
"value":"Location.active"
},
"definition":{
"short":{
"value":"Whether the location is still used to provide services"
},
"formal":{
"value":"Whether the location is still used to provide services."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./statusCode"
}
}
]
}
},
{
"path":{
"value":"Location.partOf"
},
"definition":{
"short":{
"value":"Another Location which this Location is physically inside of"
},
"formal":{
"value":"Another Location which this Location is physically inside of."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"LocationType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/location-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Contact details and position information for a physical place that may be visited and where healthcare resources and participants may be found or contained, accommodated, or stored.\" class=\"dict\" href=\"location-definitions.htm#Location\"><b>Location<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Name of the location which identifies it to its users.\" class=\"dict\" href=\"location-definitions.htm#Location.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the location<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Description of the Location, which helps in finding or referencing the place.\" class=\"dict\" href=\"location-definitions.htm#Location.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the Location<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Classification of the location.\" class=\"dict\" href=\"location-definitions.htm#Location.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-location-type.htm\">Classification of the location<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The contact details of the main communication devices present at the location.\" class=\"dict\" href=\"location-definitions.htm#Location.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact details of the location<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Physical location.\" class=\"dict\" href=\"location-definitions.htm#Location.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Physical location<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The absolute geographic location of the Location, expressed in a KML compatible manner (see notes below for KML).\" class=\"dict\" href=\"location-definitions.htm#Location.position\"><b>position<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> The absolute geographic location --><\/span>\r\n <<a title=\"Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.longitude\"><b>longitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Longitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.latitude\"><b>latitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Latitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).\" class=\"dict\" href=\"location-definitions.htm#Location.position.altitude\"><b>altitude<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Altitude<\/span><span style=\"color: Gray\"> --><\/span>\r\n </position>\r\n <<a title=\"The organization that provides services at the location.\" class=\"dict\" href=\"location-definitions.htm#Location.provider\"><b>provider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The organization that provides services at the location<\/span><span style=\"color: Gray\"> --><\/span></provider>\r\n <<a title=\"Whether the location is still used to provide services (this element modifies the meaning of other elements)\" class=\"dict\" href=\"location-definitions.htm#Location.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether the location is still used to provide services<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Another Location which this Location is physically inside of.\" class=\"dict\" href=\"location-definitions.htm#Location.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Another Location which this Location is physically inside of<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n</Location>\r\n<\/pre><\/div>"
},
{
"title":"\"media\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/media",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/media.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A photo, video, or audio recording acquired or used in healthcare. The actual content maybe inline or provided by direct reference.\" class=\"dict\" href=\"media-definitions.htm#Media\"><b>Media<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Whether the media is a photo (still image), an audio recording, or a video recording.\" class=\"dict\" href=\"media-definitions.htm#Media.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"media-type.htm\">photo | audio | video<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"media-definitions.htm#Media.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-subtype.htm\">The type of acquisition equipment/process<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"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.\" class=\"dict\" href=\"media-definitions.htm#Media.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier(s) for the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording.\" class=\"dict\" href=\"media-definitions.htm#Media.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the media was taken/recorded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who/What this Media is a record of.\" class=\"dict\" href=\"media-definitions.htm#Media.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">Who/What this Media is a record of<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who requested that this image be collected.\" class=\"dict\" href=\"media-definitions.htm#Media.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who asked that this image be collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"The person who administered the collection of the image.\" class=\"dict\" href=\"media-definitions.htm#Media.operator\"><b>operator<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The person who generated the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></operator>\r\n <<a title=\"The name of the imaging view e.g Lateral or Antero-posterior (AP).\" class=\"dict\" href=\"media-definitions.htm#Media.view\"><b>view<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-view.htm\">Imaging view e.g Lateral or Antero-posterior<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></view>\r\n <<a title=\"The name of the device / manufacturer of the device that was used to make the recording.\" class=\"dict\" href=\"media-definitions.htm#Media.deviceName\"><b>deviceName<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the device/manufacturer<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Height of the image in pixels(photo/video).\" class=\"dict\" href=\"media-definitions.htm#Media.height\"><b>height<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Height can only be used for a photo or video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Height of the image in pixels(photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Width of the image in pixels (photo/video).\" class=\"dict\" href=\"media-definitions.htm#Media.width\"><b>width<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Width can only be used for a photo or video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Width of the image in pixels (photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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 iamge, or an animated gif. If there is more than one frame, this must have a value in order to alert interface software that a multi-frame capable rendering widget is required.\" class=\"dict\" href=\"media-definitions.htm#Media.frames\"><b>frames<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Frames can only be used for a photo\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of frames if > 1 (photo)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The length of the recording in seconds - for audio and video.\" class=\"dict\" href=\"media-definitions.htm#Media.length\"><b>length<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Length can only be used for an audio or a video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Length in seconds (audio / video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The actual content of the media - inline or by direct reference to the media source file.\" class=\"dict\" href=\"media-definitions.htm#Media.content\"><b>content<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Actual Media - reference or data<\/span><span style=\"color: Gray\"> --><\/span></content>\r\n</Media>\r\n<\/pre><\/div>"
},
"name":{
"value":"media"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A photo, video, or audio recording acquired or used in healthcare. The actual content maybe inline or provided by direct reference."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Media"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Media"
},
"definition":{
"short":{
"value":"A photo, video, or audio recording acquired or used in healthcare. The actual content maybe inline or provided by direct reference"
},
"formal":{
"value":"A photo, video, or audio recording acquired or used in healthcare. The actual content maybe inline or provided by direct reference."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"Frames rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"Frames can only be used for a photo"
},
"xpath":{
"value":"(f:type/@value='photo') or not(f:frames)"
}
},
{
"key":{
"value":"2"
},
"name":{
"value":"Width rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"Width can only be used for a photo or video"
},
"xpath":{
"value":"not(f:type/@value='audio') or not(f:width)"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"Height rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"Height can only be used for a photo or video"
},
"xpath":{
"value":"not(f:type/@value='audio') or not(f:height)"
}
},
{
"key":{
"value":"4"
},
"name":{
"value":"Length rule"
},
"severity":{
"value":"error"
},
"human":{
"value":"Length can only be used for an audio or a video"
},
"xpath":{
"value":"not(f:type/@value='photo') or not(f:length)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"DiagnosticImage"
}
}
]
}
},
{
"path":{
"value":"Media.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Media.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Media.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Media.type"
},
"definition":{
"short":{
"value":"photo | audio | video"
},
"formal":{
"value":"Whether the media is a photo (still image), an audio recording, or a video recording."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MediaType"
}
}
},
{
"path":{
"value":"Media.subtype"
},
"definition":{
"short":{
"value":"The type of acquisition equipment/process"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MediaSubtype"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0060 | 0008,1032"
}
}
]
}
},
{
"path":{
"value":"Media.identifier"
},
"definition":{
"short":{
"value":"Identifier(s) for the image"
},
"formal":{
"value":"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":{
"value":"The identifier label and use can be used to determine what kind of identifier it is."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".id"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0018 | ~0008,0050 | 0020,000D | 0020,000E"
}
}
]
}
},
{
"path":{
"value":"Media.dateTime"
},
"definition":{
"short":{
"value":"When the media was taken/recorded"
},
"formal":{
"value":"When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording."
},
"comments":{
"value":"For an image including multiple frames, this is the start time."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".effectiveTime"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0020 + 0008,0030"
}
}
]
}
},
{
"path":{
"value":"Media.subject"
},
"definition":{
"short":{
"value":"Who/What this Media is a record of"
},
"formal":{
"value":"Who/What this Media is a record of."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|Group|Device|Specimen)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".participation[typeCode=\"SUBJ\"]\u2026"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"~0010,0020"
}
}
]
}
},
{
"path":{
"value":"Media.requester"
},
"definition":{
"short":{
"value":"Who asked that this image be collected"
},
"formal":{
"value":"Who requested that this image be collected."
},
"comments":{
"value":"Helps connect to workflow etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".participation[typeCode=\"REFB\"]\u2026"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0090"
}
}
]
}
},
{
"path":{
"value":"Media.operator"
},
"definition":{
"short":{
"value":"The person who generated the image"
},
"formal":{
"value":"The person who administered the collection of the image."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".participation[typeCode=\"PERF\"]\u2026"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,1060?"
}
}
]
}
},
{
"path":{
"value":"Media.view"
},
"definition":{
"short":{
"value":"Imaging view e.g Lateral or Antero-posterior"
},
"formal":{
"value":"The name of the imaging view e.g Lateral or Antero-posterior (AP)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MediaView"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"DiagnosticImage.subjectOrientationCode"
}
}
]
}
},
{
"path":{
"value":"Media.deviceName"
},
"definition":{
"short":{
"value":"Name of the device/manufacturer"
},
"formal":{
"value":"The name of the device / manufacturer of the device that was used to make the recording."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".participation[typeCode=\"DEV\"].role.player.Entity[classCode=\"DEV\"].name"
}
},
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0008,0070"
}
}
]
}
},
{
"path":{
"value":"Media.height"
},
"definition":{
"short":{
"value":"Height of the image in pixels(photo/video)"
},
"formal":{
"value":"Height of the image in pixels(photo/video)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0028,0010"
}
}
]
}
},
{
"path":{
"value":"Media.width"
},
"definition":{
"short":{
"value":"Width of the image in pixels (photo/video)"
},
"formal":{
"value":"Width of the image in pixels (photo/video)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"0028,0011"
}
}
]
}
},
{
"path":{
"value":"Media.frames"
},
"definition":{
"short":{
"value":"Number of frames if > 1 (photo)"
},
"formal":{
"value":"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 iamge, or an animated gif. If there is more than one frame, this must have a value in order to alert interface software that a multi-frame capable rendering widget is required."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Media.length"
},
"definition":{
"short":{
"value":"Length in seconds (audio / video)"
},
"formal":{
"value":"The length of the recording in seconds - for audio and video."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"~0028,0002"
}
}
]
}
},
{
"path":{
"value":"Media.content"
},
"definition":{
"short":{
"value":"Actual Media - reference or data"
},
"formal":{
"value":"The actual content of the media - inline or by direct reference to the media source file."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"MediaType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/media-type"
}
}
},
{
"name":{
"value":"MediaSubtype"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/media-subtype"
}
}
},
{
"name":{
"value":"MediaView"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/media-view"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A photo, video, or audio recording acquired or used in healthcare. The actual content maybe inline or provided by direct reference.\" class=\"dict\" href=\"media-definitions.htm#Media\"><b>Media<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Whether the media is a photo (still image), an audio recording, or a video recording.\" class=\"dict\" href=\"media-definitions.htm#Media.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"media-type.htm\">photo | audio | video<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"media-definitions.htm#Media.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-subtype.htm\">The type of acquisition equipment/process<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"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.\" class=\"dict\" href=\"media-definitions.htm#Media.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier(s) for the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"When the media was originally recorded. For video and audio, if the length of the recording is not insignificant, this is the end of the recording.\" class=\"dict\" href=\"media-definitions.htm#Media.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the media was taken/recorded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who/What this Media is a record of.\" class=\"dict\" href=\"media-definitions.htm#Media.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">Who/What this Media is a record of<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who requested that this image be collected.\" class=\"dict\" href=\"media-definitions.htm#Media.requester\"><b>requester<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who asked that this image be collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></requester>\r\n <<a title=\"The person who administered the collection of the image.\" class=\"dict\" href=\"media-definitions.htm#Media.operator\"><b>operator<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The person who generated the image<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></operator>\r\n <<a title=\"The name of the imaging view e.g Lateral or Antero-posterior (AP).\" class=\"dict\" href=\"media-definitions.htm#Media.view\"><b>view<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-media-view.htm\">Imaging view e.g Lateral or Antero-posterior<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></view>\r\n <<a title=\"The name of the device / manufacturer of the device that was used to make the recording.\" class=\"dict\" href=\"media-definitions.htm#Media.deviceName\"><b>deviceName<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the device/manufacturer<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Height of the image in pixels(photo/video).\" class=\"dict\" href=\"media-definitions.htm#Media.height\"><b>height<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Height can only be used for a photo or video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Height of the image in pixels(photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Width of the image in pixels (photo/video).\" class=\"dict\" href=\"media-definitions.htm#Media.width\"><b>width<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Width can only be used for a photo or video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Width of the image in pixels (photo/video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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 iamge, or an animated gif. If there is more than one frame, this must have a value in order to alert interface software that a multi-frame capable rendering widget is required.\" class=\"dict\" href=\"media-definitions.htm#Media.frames\"><b>frames<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Frames can only be used for a photo\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of frames if > 1 (photo)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The length of the recording in seconds - for audio and video.\" class=\"dict\" href=\"media-definitions.htm#Media.length\"><b>length<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-4: Length can only be used for an audio or a video\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Length in seconds (audio / video)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The actual content of the media - inline or by direct reference to the media source file.\" class=\"dict\" href=\"media-definitions.htm#Media.content\"><b>content<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Actual Media - reference or data<\/span><span style=\"color: Gray\"> --><\/span></content>\r\n</Media>\r\n<\/pre><\/div>"
},
{
"title":"\"medication\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/medication",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/medication.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Primarily used for identification and definition of Medication, but also covers ingredients and packaging.\" class=\"dict\" href=\"medication-definitions.htm#Medication\"><b>Medication<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The common name of the medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Common / Commercial name<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"References to codes for this medication in standard medication terminologies, drug dictionaries, etc.\" class=\"dict\" href=\"medication-definitions.htm#Medication.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-codes.htm\">References to std. medication terminologies<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).\" class=\"dict\" href=\"medication-definitions.htm#Medication.isBrand\"><b>isBrand<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if a brand<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the details of the manufacturer.\" class=\"dict\" href=\"medication-definitions.htm#Medication.manufacturer\"><b>manufacturer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Manufacturer of the item<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></manufacturer>\r\n <<a title=\"product | package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.kind\"><b>kind<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-kind.htm\">product | package<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If is a product.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product\"><b>product<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If is a product --><\/span>\r\n <<a title=\"Describes the form of the item. Powder; tables; carton.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.form\"><b>form<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-form-codes.htm\">Powder | tablets | carton etc<\/a><\/span><span style=\"color: Gray\"> --><\/span></form>\r\n <<a title=\"The ingredients of the medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient\"><b>ingredient<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Ingredients, if specified --><\/span>\r\n <<a title=\"The actual ingredient - either a substance (simple ingredient) or another medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Ingredient<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n <<a title=\"Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient.amount\"><b>amount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Amount of ingredient<\/span><span style=\"color: Gray\"> --><\/span></amount>\r\n </ingredient>\r\n </product>\r\n <<a title=\"Specifies Ingredient / Product / Package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package\"><b>package<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If is a package --><\/span>\r\n <<a title=\"The kind of container that this package comes as.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.container\"><b>container<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-package-form-codes.htm\">Kind of container<\/a><\/span><span style=\"color: Gray\"> --><\/span></container>\r\n <<a title=\"A set of components that go to make up the described item.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content\"><b>content<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> What is in the package --><\/span>\r\n <<a title=\"The product that is in the package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">A product in the package<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n <<a title=\"The amount of the product that is in the package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content.amount\"><b>amount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount in the package<\/span><span style=\"color: Gray\"> --><\/span></amount>\r\n </content>\r\n </package>\r\n</Medication>\r\n<\/pre><\/div>"
},
"name":{
"value":"medication"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Primarily used for identification and definition of Medication, but also covers ingredients and packaging."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Medication"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Medication"
},
"definition":{
"short":{
"value":"Definition of a Medication"
},
"formal":{
"value":"Primarily used for identification and definition of Medication, but also covers ingredients and packaging."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.name"
},
"definition":{
"short":{
"value":"Common / Commercial name"
},
"formal":{
"value":"The common name of the medication."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Medication.code"
},
"definition":{
"short":{
"value":"References to std. medication terminologies"
},
"formal":{
"value":"References to codes for this medication in standard medication terminologies, drug dictionaries, etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Medication.isBrand"
},
"definition":{
"short":{
"value":"True if a brand"
},
"formal":{
"value":"Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.manufacturer"
},
"definition":{
"short":{
"value":"Manufacturer of the item"
},
"formal":{
"value":"Describes the details of the manufacturer."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
}
}
]
}
},
{
"path":{
"value":"Medication.kind"
},
"definition":{
"short":{
"value":"product | package"
},
"formal":{
"value":"product | package."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationKind"
}
}
},
{
"path":{
"value":"Medication.product"
},
"definition":{
"short":{
"value":"If is a product"
},
"formal":{
"value":"If is a product."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.product.form"
},
"definition":{
"short":{
"value":"Powder | tablets | carton etc"
},
"formal":{
"value":"Describes the form of the item. Powder; tables; carton."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationForm"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Medication.product.ingredient"
},
"definition":{
"short":{
"value":"Ingredients, if specified"
},
"formal":{
"value":"The ingredients of the medication."
},
"comments":{
"value":"The ingredients need not be a complete list; usually only active ingredients are listed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.product.ingredient.item"
},
"definition":{
"short":{
"value":"Ingredient"
},
"formal":{
"value":"The actual ingredient - either a substance (simple ingredient) or another medication."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Substance|Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"if substance: RXC-2-Component Code\nif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
}
}
]
}
},
{
"path":{
"value":"Medication.product.ingredient.amount"
},
"definition":{
"short":{
"value":"Amount of ingredient"
},
"formal":{
"value":"Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"if substance: RXC-3-Component Amount & RXC-4-Component Units\nif 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"
}
}
]
}
},
{
"path":{
"value":"Medication.package"
},
"definition":{
"short":{
"value":"If is a package"
},
"formal":{
"value":"Specifies Ingredient / Product / Package."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.package.container"
},
"definition":{
"short":{
"value":"Kind of container"
},
"formal":{
"value":"The kind of container that this package comes as."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationContainer"
}
}
},
{
"path":{
"value":"Medication.package.content"
},
"definition":{
"short":{
"value":"What is in the package"
},
"formal":{
"value":"A set of components that go to make up the described item."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.package.content.item"
},
"definition":{
"short":{
"value":"A product in the package"
},
"formal":{
"value":"The product that is in the package."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Medication.package.content.amount"
},
"definition":{
"short":{
"value":"Amount in the package"
},
"formal":{
"value":"The amount of the product that is in the package."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"MedicationContainer"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-package-form-codes"
}
}
},
{
"name":{
"value":"MedicationKind"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-kind"
}
}
},
{
"name":{
"value":"MedicationForm"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-form-codes"
}
}
},
{
"name":{
"value":"MedicationCode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-codes"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Primarily used for identification and definition of Medication, but also covers ingredients and packaging.\" class=\"dict\" href=\"medication-definitions.htm#Medication\"><b>Medication<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The common name of the medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Common / Commercial name<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"References to codes for this medication in standard medication terminologies, drug dictionaries, etc.\" class=\"dict\" href=\"medication-definitions.htm#Medication.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-codes.htm\">References to std. medication terminologies<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).\" class=\"dict\" href=\"medication-definitions.htm#Medication.isBrand\"><b>isBrand<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if a brand<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the details of the manufacturer.\" class=\"dict\" href=\"medication-definitions.htm#Medication.manufacturer\"><b>manufacturer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Manufacturer of the item<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></manufacturer>\r\n <<a title=\"product | package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.kind\"><b>kind<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-kind.htm\">product | package<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If is a product.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product\"><b>product<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If is a product --><\/span>\r\n <<a title=\"Describes the form of the item. Powder; tables; carton.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.form\"><b>form<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-form-codes.htm\">Powder | tablets | carton etc<\/a><\/span><span style=\"color: Gray\"> --><\/span></form>\r\n <<a title=\"The ingredients of the medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient\"><b>ingredient<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Ingredients, if specified --><\/span>\r\n <<a title=\"The actual ingredient - either a substance (simple ingredient) or another medication.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Ingredient<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n <<a title=\"Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.\" class=\"dict\" href=\"medication-definitions.htm#Medication.product.ingredient.amount\"><b>amount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Amount of ingredient<\/span><span style=\"color: Gray\"> --><\/span></amount>\r\n </ingredient>\r\n </product>\r\n <<a title=\"Specifies Ingredient / Product / Package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package\"><b>package<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If is a package --><\/span>\r\n <<a title=\"The kind of container that this package comes as.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.container\"><b>container<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-medication-package-form-codes.htm\">Kind of container<\/a><\/span><span style=\"color: Gray\"> --><\/span></container>\r\n <<a title=\"A set of components that go to make up the described item.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content\"><b>content<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> What is in the package --><\/span>\r\n <<a title=\"The product that is in the package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content.item\"><b>item<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">A product in the package<\/span><span style=\"color: Gray\"> --><\/span></item>\r\n <<a title=\"The amount of the product that is in the package.\" class=\"dict\" href=\"medication-definitions.htm#Medication.package.content.amount\"><b>amount<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount in the package<\/span><span style=\"color: Gray\"> --><\/span></amount>\r\n </content>\r\n </package>\r\n</Medication>\r\n<\/pre><\/div>"
},
{
"title":"\"medicationadministration\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/medicationadministration",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/medicationadministration.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration\"><b>MedicationAdministration<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-admin-status.htm\">Status of the administration - active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication was given.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The individual who is responsible for giving the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.practitioner\"><b>practitioner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Practitioner (responsible Health Care professional)<\/span><span style=\"color: Gray\"> --><\/span></practitioner>\r\n <<a title=\"An link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Current Encounter / Admission<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"A link to a resource that provides the original request, instruction and authority to perform the administration.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.prescription\"><b>prescription<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">Prescription<\/span><span style=\"color: Gray\"> --><\/span></prescription>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.wasNotGiven\"><span style=\"text-decoration: underline\"><b>wasNotGiven<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if asserting medication was not given<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.reasonNotGiven\"><b>reasonNotGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.htm\">Reason event is negated<\/a><\/span><span style=\"color: Gray\"> --><\/span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.whenGiven\"><b>whenGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Effective time<\/span><span style=\"color: Gray\"> --><\/span></whenGiven>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.administrationDevice\"><b>administrationDevice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Administration device<\/span><span style=\"color: Gray\"> --><\/span></administrationDevice>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.timing\"><b>timing<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of themedication 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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the medication is 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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationAdministration>\r\n<\/pre><\/div>"
},
"name":{
"value":"medicationadministration"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"MedicationAdministration"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"MedicationAdministration"
},
"definition":{
"short":{
"value":"Administration of medication to a patient"
},
"formal":{
"value":"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationAdministration.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationAdministration.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationAdministration.identifier"
},
"definition":{
"short":{
"value":"External Identifier"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration.id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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..*)"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.status"
},
"definition":{
"short":{
"value":"Status of the administration - active | paused | completed | nullified"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"MedicationAdministrationStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration.statusCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-20-Completion Status"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.patient"
},
"definition":{
"short":{
"value":"Patient"
},
"formal":{
"value":"A link to a resource representing the person to whom the medication was given."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration->subject->Patient"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.practitioner"
},
"definition":{
"short":{
"value":"Practitioner (responsible Health Care professional)"
},
"formal":{
"value":"The individual who is responsible for giving the medication to the patient."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.encounter"
},
"definition":{
"short":{
"value":"Current Encounter / Admission"
},
"formal":{
"value":"An link to a resource that identifies the particular occurrence of contact between patient and health care provider."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration->component->EncounterEvent"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-19-Visit Number"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.prescription"
},
"definition":{
"short":{
"value":"Prescription"
},
"formal":{
"value":"A link to a resource that provides the original request, instruction and authority to perform the administration."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(MedicationPrescription)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration->InFullfillmentOf->SubstanceAdministration"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.wasNotGiven"
},
"definition":{
"short":{
"value":"True if asserting medication was not given"
},
"formal":{
"value":"Set this to true if the record is saying that the medication was NOT administered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration.actionNegationInd"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-20-Completion Status='NA'"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.reasonNotGiven"
},
"definition":{
"short":{
"value":"Reason event is negated"
},
"formal":{
"value":"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationNegationReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration->Reason->Observation->Value"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.whenGiven"
},
"definition":{
"short":{
"value":"Effective time"
},
"formal":{
"value":"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.medication"
},
"definition":{
"short":{
"value":"Medication"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-5-Administered Code"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.administrationDevice"
},
"definition":{
"short":{
"value":"Administration device"
},
"formal":{
"value":"An identifier or a link to a resource that identifies a device used in administering the medication to the patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration->device->Access OR SubstanceAdministration->device->AssignedDevice"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-10-Participation Device"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage"
},
"definition":{
"short":{
"value":"Medicine administration instructions to the patient/carer"
},
"formal":{
"value":"Indicates how the medication is to be used by the patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"Dose"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must have at least one of dosage.quantity and dosage.rate"
},
"xpath":{
"value":"exists(f:quantity) or exists(f:rate)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"The RMIM has priority code on the act relationship. How do we handle this?"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.timing"
},
"definition":{
"short":{
"value":"Medication timing"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Schedule"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RAS:TQ1"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.site"
},
"definition":{
"short":{
"value":"Entry site"
},
"formal":{
"value":"A coded specification of the anatomic site where the medication first enters the body."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationSite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-2-Administration Site"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.route"
},
"definition":{
"short":{
"value":"Rout of administration"
},
"formal":{
"value":"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RouteOfAdministration"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-1-Route"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.method"
},
"definition":{
"short":{
"value":"Administration method"
},
"formal":{
"value":"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationMethod"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"SubstanceAdministration.methodCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-4-Administration Method"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.quantity"
},
"definition":{
"short":{
"value":"Dose quantity per dose"
},
"formal":{
"value":"The amount of themedication 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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.rate"
},
"definition":{
"short":{
"value":"Dose quantity per unit of time"
},
"formal":{
"value":"Identifies the speed with which the medication is 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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-12-Administered Per (Time Unit)"
}
}
]
}
},
{
"path":{
"value":"MedicationAdministration.dosage.maxDosePerPeriod"
},
"definition":{
"short":{
"value":"Total dose that should be consumed per unit of time"
},
"formal":{
"value":"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"MedicationAdministrationStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-admin-status"
}
}
},
{
"name":{
"value":"MedicationAdministrationMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administration-method-codes"
}
}
},
{
"name":{
"value":"MedicationAdministrationSite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/approach-site-codes"
}
}
},
{
"name":{
"value":"MedicationAdministrationNegationReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
}
},
{
"name":{
"value":"RouteOfAdministration"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/route-codes"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration\"><b>MedicationAdministration<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-admin-status.htm\">Status of the administration - active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication was given.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The individual who is responsible for giving the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.practitioner\"><b>practitioner<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Practitioner (responsible Health Care professional)<\/span><span style=\"color: Gray\"> --><\/span></practitioner>\r\n <<a title=\"An link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Current Encounter / Admission<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"A link to a resource that provides the original request, instruction and authority to perform the administration.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.prescription\"><b>prescription<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">Prescription<\/span><span style=\"color: Gray\"> --><\/span></prescription>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.wasNotGiven\"><span style=\"text-decoration: underline\"><b>wasNotGiven<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if asserting medication was not given<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.reasonNotGiven\"><b>reasonNotGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.htm\">Reason event is negated<\/a><\/span><span style=\"color: Gray\"> --><\/span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.whenGiven\"><b>whenGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Effective time<\/span><span style=\"color: Gray\"> --><\/span></whenGiven>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.administrationDevice\"><b>administrationDevice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Administration device<\/span><span style=\"color: Gray\"> --><\/span></administrationDevice>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.timing\"><b>timing<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of themedication 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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the medication is 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.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationadministration-definitions.htm#MedicationAdministration.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationAdministration>\r\n<\/pre><\/div>"
},
{
"title":"\"medicationdispense\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/medicationdispense",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/medicationdispense.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense\"><b>MedicationDispense<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.htm\">active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The individual reponsible for dispensing the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispenser\"><b>dispenser<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Dispenser<\/span><span style=\"color: Gray\"> --><\/span></dispenser>\r\n <<a title=\"Indicates the medication order that is being dispensed against.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.authorizingPrescription\"><b>authorizingPrescription<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">Medication order that authorises the dispense<\/span><span style=\"color: Gray\"> --><\/span></authorizingPrescription>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine supply details --><\/span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.htm\">Active/Completed/Aborted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActPharmacySupplyType.htm\">Type of dispense<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The amount of medication that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount dispensed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.whenPrepared\"><b>whenPrepared<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Dispensing time<\/span><span style=\"color: Gray\"> --><\/span></whenPrepared>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.whenHandedOver\"><b>whenHandedOver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Handover time<\/span><span style=\"color: Gray\"> --><\/span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the medication was shipped to, as part of the dispense event.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the medication was sent<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Identifies the person who picked up the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the medication<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.additionalInstructions_x_\"><b>additionalInstructions[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Additional dosage instructions<\/span><span style=\"color: Gray\"> --><\/span></additionalInstructions[x]>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n </dispense>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution\"><b>substitution<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Deals with substitution of one medicine for another --><\/span>\r\n <<a title=\"A code signifying whether a different drug was dispensed from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode.htm\">Type of substitiution<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason.htm\">Why was substitution made<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"The person or organization that has primary responsibility for the substitution.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.responsibleParty\"><b>responsibleParty<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who is responsible for the substitution<\/span><span style=\"color: Gray\"> --><\/span></responsibleParty>\r\n </substitution>\r\n</MedicationDispense>\r\n<\/pre><\/div>"
},
"name":{
"value":"medicationdispense"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"MedicationDispense"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"MedicationDispense"
},
"definition":{
"short":{
"value":"Dispensing a medication to a named patient"
},
"formal":{
"value":"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationDispense.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationDispense.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationDispense.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationDispense.identifier"
},
"definition":{
"short":{
"value":"External identifier"
},
"formal":{
"value":"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-25-Administered Barcode Identifier? (no unique dispense ID provided in RXD segment; V2 def'n of RXA-25 refers to the 'give' occurrence; appears not to discuss 'dispense' cardinality which would seem to be 0..*)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.status"
},
"definition":{
"short":{
"value":"active | paused | completed | nullified"
},
"formal":{
"value":"A code specifying the state of the set of dispense events."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"MedicationDispenseStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.statusCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(Not clear whether or how V2 provides for a snapshot of dispense status)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.patient"
},
"definition":{
"short":{
"value":"Patient"
},
"formal":{
"value":"A link to a resource representing the person to whom the medication will be given."
},
"comments":{
"value":"SubstanceAdministration->subject->Patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispenser"
},
"definition":{
"short":{
"value":"Dispenser"
},
"formal":{
"value":"The individual reponsible for dispensing the medication."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.authorizingPrescription"
},
"definition":{
"short":{
"value":"Medication order that authorises the dispense"
},
"formal":{
"value":"Indicates the medication order that is being dispensed against."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(MedicationPrescription)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.inFulfillmentOf"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense"
},
"definition":{
"short":{
"value":"Medicine supply details"
},
"formal":{
"value":"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"Timing"
},
"severity":{
"value":"error"
},
"human":{
"value":"whenHandedOver cannot be before whenPrepared"
},
"xpath":{
"value":"not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.identifier"
},
"definition":{
"short":{
"value":"External identifier"
},
"formal":{
"value":"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.id"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.status"
},
"definition":{
"short":{
"value":"Active/Completed/Aborted"
},
"formal":{
"value":"A code specifying the state of the dispense event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"MedicationDispenseStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.statusCode"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.type"
},
"definition":{
"short":{
"value":"Type of dispense"
},
"formal":{
"value":"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationDispenseType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-33-Dispense Type"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.quantity"
},
"definition":{
"short":{
"value":"Amount dispensed"
},
"formal":{
"value":"The amount of medication that has been dispensed. Includes unit of measure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.quantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.medication"
},
"definition":{
"short":{
"value":"Medication"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.consumable"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-2-Dispense/Give Code"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.whenPrepared"
},
"definition":{
"short":{
"value":"Dispensing time"
},
"formal":{
"value":"The time the dispense event occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-3-Date/Time Dispensed"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.whenHandedOver"
},
"definition":{
"short":{
"value":"Handover time"
},
"formal":{
"value":"The time the dispense event occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-3-Date/Time Dispensed"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.destination"
},
"definition":{
"short":{
"value":"Where the medication was sent"
},
"formal":{
"value":"Identification of the facility/location where the medication was shipped to, as part of the dispense event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.destination"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.receiver"
},
"definition":{
"short":{
"value":"Who collected the medication"
},
"formal":{
"value":"Identifies the person who picked up the medication."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.SupplyEvent.receiver"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage"
},
"definition":{
"short":{
"value":"Medicine administration instructions to the patient/carer"
},
"formal":{
"value":"Indicates how the medication is to be used by the patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.additionalInstructions[x]"
},
"definition":{
"short":{
"value":"Additional dosage instructions"
},
"formal":{
"value":"Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.timing[x]"
},
"definition":{
"short":{
"value":"Medication timing"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
},
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"Schedule"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RDS:TQ1"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.site"
},
"definition":{
"short":{
"value":"Entry site"
},
"formal":{
"value":"A coded specification of the anatomic site where the medication first enters the body."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationSite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.approachSiteCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-2-Administration Site"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.route"
},
"definition":{
"short":{
"value":"Rout of administration"
},
"formal":{
"value":"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RouteOfAdministration"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.routeCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-1-Route"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.method"
},
"definition":{
"short":{
"value":"Administration method"
},
"formal":{
"value":"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration."
},
"comments":{
"value":"SubstanceAdministration.methodCode."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationMethod"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-4-Administration Method"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.quantity"
},
"definition":{
"short":{
"value":"Dose quantity per dose"
},
"formal":{
"value":"The amount of the therapeutic or other substance given at one administration event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.doseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.rate"
},
"definition":{
"short":{
"value":"Dose quantity per unit of time"
},
"formal":{
"value":"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.rateQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-22-Give Per (Time Unit)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.dispense.dosage.maxDosePerPeriod"
},
"definition":{
"short":{
"value":"Total dose that should be consumed per unit of time"
},
"formal":{
"value":"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.AdministrationRequest.maxDoseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.substitution"
},
"definition":{
"short":{
"value":"Deals with substitution of one medicine for another"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.substitutionMade"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.substitution.type"
},
"definition":{
"short":{
"value":"Type of substitiution"
},
"formal":{
"value":"A code signifying whether a different drug was dispensed from what was prescribed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationIntendedSubstitutionType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.substitutionMade.code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.substitution.reason"
},
"definition":{
"short":{
"value":"Why was substitution made"
},
"formal":{
"value":"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationIntendedSubstitutionReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.substitutionMade.reasonCode"
}
}
]
}
},
{
"path":{
"value":"MedicationDispense.substitution.responsibleParty"
},
"definition":{
"short":{
"value":"Who is responsible for the substitution"
},
"formal":{
"value":"The person or organization that has primary responsibility for the substitution."
},
"comments":{
"value":"rename."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationDispense.substitutionMade.ResponsibleParty"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"MedicationAdministrationMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administration-method-codes"
}
}
},
{
"name":{
"value":"MedicationDispenseStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-dispense-status"
}
}
},
{
"name":{
"value":"MedicationAdministrationSite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/approach-site-codes"
}
}
},
{
"name":{
"value":"MedicationDispenseType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"
}
}
},
{
"name":{
"value":"MedicationIntendedSubstitutionType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
}
},
{
"name":{
"value":"RouteOfAdministration"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/route-codes"
}
}
},
{
"name":{
"value":"MedicationIntendedSubstitutionReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense\"><b>MedicationDispense<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.htm\">active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The individual reponsible for dispensing the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispenser\"><b>dispenser<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Dispenser<\/span><span style=\"color: Gray\"> --><\/span></dispenser>\r\n <<a title=\"Indicates the medication order that is being dispensed against.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.authorizingPrescription\"><b>authorizingPrescription<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">Medication order that authorises the dispense<\/span><span style=\"color: Gray\"> --><\/span></authorizingPrescription>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine supply details --><\/span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.htm\">Active/Completed/Aborted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActPharmacySupplyType.htm\">Type of dispense<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The amount of medication that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount dispensed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.whenPrepared\"><b>whenPrepared<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Dispensing time<\/span><span style=\"color: Gray\"> --><\/span></whenPrepared>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.whenHandedOver\"><b>whenHandedOver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Handover time<\/span><span style=\"color: Gray\"> --><\/span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the medication was shipped to, as part of the dispense event.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the medication was sent<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Identifies the person who picked up the medication.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the medication<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.additionalInstructions_x_\"><b>additionalInstructions[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Additional dosage instructions<\/span><span style=\"color: Gray\"> --><\/span></additionalInstructions[x]>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.dispense.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n </dispense>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution\"><b>substitution<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Deals with substitution of one medicine for another --><\/span>\r\n <<a title=\"A code signifying whether a different drug was dispensed from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode.htm\">Type of substitiution<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason.htm\">Why was substitution made<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"The person or organization that has primary responsibility for the substitution.\" class=\"dict\" href=\"medicationdispense-definitions.htm#MedicationDispense.substitution.responsibleParty\"><b>responsibleParty<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who is responsible for the substitution<\/span><span style=\"color: Gray\"> --><\/span></responsibleParty>\r\n </substitution>\r\n</MedicationDispense>\r\n<\/pre><\/div>"
},
{
"title":"\"medicationprescription\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/medicationprescription",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/medicationprescription.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"An order for both supply of the medication and the instructions for administration of the medicine to a patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription\"><b>MedicationPrescription<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The date (and perhaps time) when the prescription was written.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dateWritten\"><b>dateWritten<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Prescription date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code specifying the state of the order. Generally this will be active or completed state (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-prescription-status.htm\">active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The healthcare professional responsible for authorising the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.prescriber\"><b>prescriber<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Prescriber<\/span><span style=\"color: Gray\"> --><\/span></prescriber>\r\n <<a title=\"A link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Encounter / Admission / Stay<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Can be the reason or the indication for writing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.reasonForPrescribing_x_\"><b>reasonForPrescribing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason or indication for writing the prescription<\/span><span style=\"color: Gray\"> --><\/span></reasonForPrescribing[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication to be taken<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction\"><b>dosageInstruction<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Dosage instructions --><\/span>\r\n <<a title=\"Free text dosage instructions for cases where the instructions are too complex to code.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.dosageInstructionsText\"><b>dosageInstructionsText<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dosage text<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.additionalInstructions_x_\"><b>additionalInstructions[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Additional dosage instructions<\/span><span style=\"color: Gray\"> --><\/span></additionalInstructions[x]>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Route of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.doseQuantity\"><b>doseQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></doseQuantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosageInstruction>\r\n <<a title=\"Deals with details of the dispense part of the order.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Dispense request --><\/span>\r\n <<a title=\"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . 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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication to be dispensed<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt 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. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.validityPeriod\"><b>validityPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Validity period<\/span><span style=\"color: Gray\"> --><\/span></validityPeriod>\r\n <<a title=\"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.numberOfRepeatsAllowed\"><b>numberOfRepeatsAllowed<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of repeats allowed<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The amount that is to be dispensed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Quanity<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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. \nIn 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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.expectedSupplyDuration\"><b>expectedSupplyDuration<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Duration\">Duration<\/a><\/span> <span style=\"color: navy\">Expected supply duration<\/span><span style=\"color: Gray\"> --><\/span></expectedSupplyDuration>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution can or should as 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 prescribers intent. If nothing is specified substitution may be done.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution\"><b>substitution<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Deals with substitution of one medicine for another --><\/span>\r\n <<a title=\"A code signifying whether a different drug should be dispensed from what was prescribed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode.htm\">Type of substitiution<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates the reason for the substitution why substitution must or must not be performed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason.htm\">Why should substitution (not) be made<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n </substitution>\r\n</MedicationPrescription>\r\n<\/pre><\/div>"
},
"name":{
"value":"medicationprescription"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. An order for both supply of the medication and the instructions for administration of the medicine to a patient."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"MedicationPrescription"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"MedicationPrescription"
},
"definition":{
"short":{
"value":"Prescription of medication to for patient"
},
"formal":{
"value":"An order for both supply of the medication and the instructions for administration of the medicine to a patient."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.identifier"
},
"definition":{
"short":{
"value":"External identifier"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-2-Placer Order Number / ORC-3-Filler Order Number"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dateWritten"
},
"definition":{
"short":{
"value":"Prescription date"
},
"formal":{
"value":"The date (and perhaps time) when the prescription was written."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.Author.time"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.status"
},
"definition":{
"short":{
"value":"active | paused | completed | nullified"
},
"formal":{
"value":"A code specifying the state of the order. Generally this will be active or completed state."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"MedicationPrescriptionStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.statusCode"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.patient"
},
"definition":{
"short":{
"value":"Patient"
},
"formal":{
"value":"A link to a resource representing the person to whom the medication will be given."
},
"comments":{
"value":"SubstanceAdministration->subject->Patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.prescriber"
},
"definition":{
"short":{
"value":"Prescriber"
},
"formal":{
"value":"The healthcare professional responsible for authorising the prescription."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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)"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.encounter"
},
"definition":{
"short":{
"value":"Encounter / Admission / Stay"
},
"formal":{
"value":"A link to a resource that identifies the particular occurrence of contact between patient and health care provider."
},
"comments":{
"value":"SubstanceAdministration->component->EncounterEvent."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PV1-19-Visit Number"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.reasonForPrescribing[x]"
},
"definition":{
"short":{
"value":"Reason or indication for writing the prescription"
},
"formal":{
"value":"Can be the reason or the indication for writing the prescription."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.RSON.A_SupportingClinicalInformation"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-16-Order Control Code Reason"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.medication"
},
"definition":{
"short":{
"value":"Medication to be taken"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.consumable"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction"
},
"definition":{
"short":{
"value":"Dosage instructions"
},
"formal":{
"value":"Indicates how the medication is to be used by the patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.dosageInstructionsText"
},
"definition":{
"short":{
"value":"Dosage text"
},
"formal":{
"value":"Free text dosage instructions for cases where the instructions are too complex to code."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.additionalInstructions[x]"
},
"definition":{
"short":{
"value":"Additional dosage instructions"
},
"formal":{
"value":"Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.timing[x]"
},
"definition":{
"short":{
"value":"Medication timing"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
},
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"Schedule"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RDS:TQ1"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.site"
},
"definition":{
"short":{
"value":"Entry site"
},
"formal":{
"value":"A coded specification of the anatomic site where the medication first enters the body."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationSite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.approachSiteCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-2-Administration Site"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.route"
},
"definition":{
"short":{
"value":"Route of administration"
},
"formal":{
"value":"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RouteOfAdministration"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.routeCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-1-Route"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.method"
},
"definition":{
"short":{
"value":"Administration method"
},
"formal":{
"value":"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration."
},
"comments":{
"value":"SubstanceAdministration.methodCode."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationMethod"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-4-Administration Method"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.doseQuantity"
},
"definition":{
"short":{
"value":"Dose quantity per dose"
},
"formal":{
"value":"The amount of the therapeutic or other substance given at one administration event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.doseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.rate"
},
"definition":{
"short":{
"value":"Dose quantity per unit of time"
},
"formal":{
"value":"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.rateQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-22-Give Per (Time Unit)"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dosageInstruction.maxDosePerPeriod"
},
"definition":{
"short":{
"value":"Total dose that should be consumed per unit of time"
},
"formal":{
"value":"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.maxDoseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dispense"
},
"definition":{
"short":{
"value":"Dispense request"
},
"formal":{
"value":"Deals with details of the dispense part of the order."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.dispense.medication"
},
"definition":{
"short":{
"value":"Medication to be dispensed"
},
"formal":{
"value":"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . 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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.administration.consumable"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dispense.validityPeriod"
},
"definition":{
"short":{
"value":"Validity period"
},
"formal":{
"value":"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt 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. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component2.dispense.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dispense.numberOfRepeatsAllowed"
},
"definition":{
"short":{
"value":"Number of repeats allowed"
},
"formal":{
"value":"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component2.dispense.repeatNumber"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-12-Number of Refills"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dispense.quantity"
},
"definition":{
"short":{
"value":"Quanity"
},
"formal":{
"value":"The amount that is to be dispensed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component2.dispense.quantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.dispense.expectedSupplyDuration"
},
"definition":{
"short":{
"value":"Expected supply duration"
},
"formal":{
"value":"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. \nIn 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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Duration"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component2.dispense.expectedUseTime"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.substitution"
},
"definition":{
"short":{
"value":"Deals with substitution of one medicine for another"
},
"formal":{
"value":"Indicates whether or not substitution can or should as 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 prescribers intent. If nothing is specified substitution may be done."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationPrescription.substitution.type"
},
"definition":{
"short":{
"value":"Type of substitiution"
},
"formal":{
"value":"A code signifying whether a different drug should be dispensed from what was prescribed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationIntendedSubstitutionType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.subjectOf.SubstitutionPermission.code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXO-9-Allow Substitutions / RXE-9-Substitution Status?"
}
}
]
}
},
{
"path":{
"value":"MedicationPrescription.substitution.reason"
},
"definition":{
"short":{
"value":"Why should substitution (not) be made"
},
"formal":{
"value":"Indicates the reason for the substitution why substitution must or must not be performed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationIntendedSubstitutionReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.subjectOf.SubstitutionPermission.reasonCode"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"MedicationAdministrationMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administration-method-codes"
}
}
},
{
"name":{
"value":"MedicationAdministrationSite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/approach-site-codes"
}
}
},
{
"name":{
"value":"MedicationPrescriptionStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/medication-prescription-status"
}
}
},
{
"name":{
"value":"MedicationIntendedSubstitutionType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
}
},
{
"name":{
"value":"RouteOfAdministration"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/route-codes"
}
}
},
{
"name":{
"value":"MedicationIntendedSubstitutionReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"An order for both supply of the medication and the instructions for administration of the medicine to a patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription\"><b>MedicationPrescription<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The date (and perhaps time) when the prescription was written.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dateWritten\"><b>dateWritten<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Prescription date<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code specifying the state of the order. Generally this will be active or completed state (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-prescription-status.htm\">active | paused | completed | nullified<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The healthcare professional responsible for authorising the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.prescriber\"><b>prescriber<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Prescriber<\/span><span style=\"color: Gray\"> --><\/span></prescriber>\r\n <<a title=\"A link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Encounter / Admission / Stay<\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Can be the reason or the indication for writing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.reasonForPrescribing_x_\"><b>reasonForPrescribing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason or indication for writing the prescription<\/span><span style=\"color: Gray\"> --><\/span></reasonForPrescribing[x]>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication to be taken<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction\"><b>dosageInstruction<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Dosage instructions --><\/span>\r\n <<a title=\"Free text dosage instructions for cases where the instructions are too complex to code.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.dosageInstructionsText\"><b>dosageInstructionsText<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Dosage text<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.additionalInstructions_x_\"><b>additionalInstructions[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Additional dosage instructions<\/span><span style=\"color: Gray\"> --><\/span></additionalInstructions[x]>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.timing_x_\"><b>timing[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Route of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.doseQuantity\"><b>doseQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></doseQuantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dosageInstruction.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosageInstruction>\r\n <<a title=\"Deals with details of the dispense part of the order.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Dispense request --><\/span>\r\n <<a title=\"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . 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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication to be dispensed<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt 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. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.validityPeriod\"><b>validityPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Validity period<\/span><span style=\"color: Gray\"> --><\/span></validityPeriod>\r\n <<a title=\"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.numberOfRepeatsAllowed\"><b>numberOfRepeatsAllowed<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Number of repeats allowed<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The amount that is to be dispensed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Quanity<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"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. \nIn 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.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.dispense.expectedSupplyDuration\"><b>expectedSupplyDuration<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Duration\">Duration<\/a><\/span> <span style=\"color: navy\">Expected supply duration<\/span><span style=\"color: Gray\"> --><\/span></expectedSupplyDuration>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution can or should as 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 prescribers intent. If nothing is specified substitution may be done.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution\"><b>substitution<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Deals with substitution of one medicine for another --><\/span>\r\n <<a title=\"A code signifying whether a different drug should be dispensed from what was prescribed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode.htm\">Type of substitiution<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Indicates the reason for the substitution why substitution must or must not be performed.\" class=\"dict\" href=\"medicationprescription-definitions.htm#MedicationPrescription.substitution.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason.htm\">Why should substitution (not) be made<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n </substitution>\r\n</MedicationPrescription>\r\n<\/pre><\/div>"
},
{
"title":"\"medicationstatement\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/medicationstatement",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/medicationstatement.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement\"><b>MedicationStatement<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A link to a resource representing the person to whom the medication was given.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.wasNotGiven\"><b>wasNotGiven<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if asserting medication was not given<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.reasonNotGiven\"><b>reasonNotGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.htm\">True if asserting medication was not given<\/a><\/span><span style=\"color: Gray\"> --><\/span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.whenGiven\"><b>whenGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Effective time<\/span><span style=\"color: Gray\"> --><\/span></whenGiven>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.administrationDevice\"><b>administrationDevice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Administration device<\/span><span style=\"color: Gray\"> --><\/span></administrationDevice>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.timing\"><b>timing<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationStatement>\r\n<\/pre><\/div>"
},
"name":{
"value":"medicationstatement"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"MedicationStatement"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"MedicationStatement"
},
"definition":{
"short":{
"value":"Administration of medication to a patient"
},
"formal":{
"value":"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."
},
"comments":{
"value":"SubstanceAdministration."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationStatement.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationStatement.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationStatement.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationStatement.identifier"
},
"definition":{
"short":{
"value":"External Identifier"
},
"formal":{
"value":"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."
},
"comments":{
"value":"SubstanceAdministration.id."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-25-Administered Barcode Identifier?"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.patient"
},
"definition":{
"short":{
"value":"Patient"
},
"formal":{
"value":"A link to a resource representing the person to whom the medication was given."
},
"comments":{
"value":"SubstanceAdministration->subject->Patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-Patient ID List"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.wasNotGiven"
},
"definition":{
"short":{
"value":"True if asserting medication was not given"
},
"formal":{
"value":"Set this to true if the record is saying that the medication was NOT administered."
},
"comments":{
"value":"SubstanceAdministration.actionNegationInd."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-20-Completion Status='NA'"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.reasonNotGiven"
},
"definition":{
"short":{
"value":"True if asserting medication was not given"
},
"formal":{
"value":"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE."
},
"comments":{
"value":"SubstanceAdministration->Reason->Observation->Value."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationNegationReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.whenGiven"
},
"definition":{
"short":{
"value":"Effective time"
},
"formal":{
"value":"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same."
},
"comments":{
"value":"SubstanceAdministration.effectiveTime."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.medication"
},
"definition":{
"short":{
"value":"Medication"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.consumable"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-5-Administered Code"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.administrationDevice"
},
"definition":{
"short":{
"value":"Administration device"
},
"formal":{
"value":"An identifier or a link to a resource that identifies a device used in administering the medication to the patient."
},
"comments":{
"value":"SubstanceAdministration->device->Access OR SubstanceAdministration->device->AssignedDevice."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-10-Participation Device"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage"
},
"definition":{
"short":{
"value":"Medicine administration instructions to the patient/carer"
},
"formal":{
"value":"Indicates how the medication is to be used by the patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"MedicationStatement.dosage.timing"
},
"definition":{
"short":{
"value":"Medication timing"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Schedule"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.effectiveTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RAS:TQ1"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.site"
},
"definition":{
"short":{
"value":"Entry site"
},
"formal":{
"value":"A coded specification of the anatomic site where the medication first enters the body."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationSite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.approachSiteCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-2-Administration Site"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.route"
},
"definition":{
"short":{
"value":"Rout of administration"
},
"formal":{
"value":"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RouteOfAdministration"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.routeCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-1-Route"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.method"
},
"definition":{
"short":{
"value":"Administration method"
},
"formal":{
"value":"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration."
},
"comments":{
"value":"SubstanceAdministration.methodCode."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MedicationAdministrationMethod"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXR-4-Administration Method"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.quantity"
},
"definition":{
"short":{
"value":"Dose quantity per dose"
},
"formal":{
"value":"The amount of the therapeutic or other substance given at one administration event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.doseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.rate"
},
"definition":{
"short":{
"value":"Dose quantity per unit of time"
},
"formal":{
"value":"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.rateQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXA-12-Administered Per (Time Unit)"
}
}
]
}
},
{
"path":{
"value":"MedicationStatement.dosage.maxDosePerPeriod"
},
"definition":{
"short":{
"value":"Total dose that should be consumed per unit of time"
},
"formal":{
"value":"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Ratio"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"CombinedMedicationRequest.component1.SubstanceAdministrationRequest.maxDoseQuantity"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"MedicationAdministrationMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administration-method-codes"
}
}
},
{
"name":{
"value":"MedicationAdministrationSite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/approach-site-codes"
}
}
},
{
"name":{
"value":"MedicationAdministrationNegationReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
}
},
{
"name":{
"value":"RouteOfAdministration"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/route-codes"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement\"><b>MedicationStatement<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.identifier\"><span style=\"text-decoration: underline\"><b>identifier<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A link to a resource representing the person to whom the medication was given.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.wasNotGiven\"><b>wasNotGiven<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">True if asserting medication was not given<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating why the administration has been negated.\n\nUse only if isNegated is set to TRUE.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.reasonNotGiven\"><b>reasonNotGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.htm\">True if asserting medication was not given<\/a><\/span><span style=\"color: Gray\"> --><\/span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration takes place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.whenGiven\"><b>whenGiven<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Effective time<\/span><span style=\"color: Gray\"> --><\/span></whenGiven>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.medication\"><b>medication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>)<\/span> <span style=\"color: navy\">Medication<\/span><span style=\"color: Gray\"> --><\/span></medication>\r\n <<a title=\"An identifier or a link to a resource that identifies a device used in administering the medication to the patient.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.administrationDevice\"><b>administrationDevice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Administration device<\/span><span style=\"color: Gray\"> --><\/span></administrationDevice>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage\"><b>dosage<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Medicine administration instructions to the patient/carer --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.timing\"><b>timing<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">Medication timing<\/span><span style=\"color: Gray\"> --><\/span></timing>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.site\"><b>site<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.htm\">Entry site<\/a><\/span><span style=\"color: Gray\"> --><\/span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.route\"><b>route<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.htm\">Rout of administration<\/a><\/span><span style=\"color: Gray\"> --><\/span></route>\r\n <<a title=\"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.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.htm\">Administration method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"The amount of the therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Dose quantity per dose<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.rate\"><b>rate<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Dose quantity per unit of time<\/span><span style=\"color: Gray\"> --><\/span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that my be administered to a subject over the period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationstatement-definitions.htm#MedicationStatement.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Ratio\">Ratio<\/a><\/span> <span style=\"color: navy\">Total dose that should be consumed per unit of time<\/span><span style=\"color: Gray\"> --><\/span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationStatement>\r\n<\/pre><\/div>"
},
{
"title":"\"message\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/message",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/message.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"The root for a transmission either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle of which the Message resource instance is the first resource in the bundle.\" class=\"dict\" href=\"message-definitions.htm#Message\"><b>Message<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier of this message.\" class=\"dict\" href=\"message-definitions.htm#Message.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Id of this message<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The time that the message was sent.\" class=\"dict\" href=\"message-definitions.htm#Message.timestamp\"><b>timestamp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time that the message was sent<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the event this message represents and connects it with the event definition in the FHIR specification (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.event\"><span style=\"text-decoration: underline\"><b>event<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.htm\">Code for the event this message represents<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.response\"><span style=\"text-decoration: underline\"><b>response<\/b><\/span><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this is a reply to prior message --><\/span>\r\n <<a title=\"The id of the message that this a response to.\" class=\"dict\" href=\"message-definitions.htm#Message.response.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Id of original message<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.response.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"response-code.htm\">Type of response to the message<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Full details of any issues found in the message.\" class=\"dict\" href=\"message-definitions.htm#Message.response.details\"><b>details<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"operationoutcome.htm#OperationOutcome\">OperationOutcome<\/a>)<\/span> <span style=\"color: navy\">Specific list of hints/warnings/errors<\/span><span style=\"color: Gray\"> --><\/span></details>\r\n </response>\r\n <<a title=\"The source application from which this message originated.\" class=\"dict\" href=\"message-definitions.htm#Message.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Message Source Application --><\/span>\r\n <<a title=\"Human readable name for the target system.\" class=\"dict\" href=\"message-definitions.htm#Message.source.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"May include configuration or other information useful in debugging.\" class=\"dict\" href=\"message-definitions.htm#Message.source.software\"><b>software<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of software running the system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Can convey versions of multiple systems in situations where a message passes through multiple hands.\" class=\"dict\" href=\"message-definitions.htm#Message.source.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version of software running<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An e-mail, phone, website or other contact point to use to resolve issues with message communications.\" class=\"dict\" href=\"message-definitions.htm#Message.source.contact\"><b>contact<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Human contact for problems<\/span><span style=\"color: Gray\"> --><\/span></contact>\r\n <<a title=\"Identifies the routing target to send acknowledgements to.\" class=\"dict\" href=\"message-definitions.htm#Message.source.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Actual message source address or id<\/span><span style=\"color: Gray\"> --><\/span>\r\n </source>\r\n <<a title=\"The destination application which the message is intended for.\" class=\"dict\" href=\"message-definitions.htm#Message.destination\"><b>destination<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Message Destination Application --><\/span>\r\n <<a title=\"Human readable name for the source system.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the target end system in situations where the initial message transmission is to an intermediary system.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Particular delivery destination within the destination<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"Indicates where the message should be routed to.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Actual destination address or id<\/span><span style=\"color: Gray\"> --><\/span>\r\n </destination>\r\n <<a title=\"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.\" class=\"dict\" href=\"message-definitions.htm#Message.enterer\"><b>enterer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The source of the data entry<\/span><span style=\"color: Gray\"> --><\/span></enterer>\r\n <<a title=\"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 Message. Can provide other authors in extensions.\" class=\"dict\" href=\"message-definitions.htm#Message.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The source of the decision<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.\" class=\"dict\" href=\"message-definitions.htm#Message.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Intended "real-world" recipient for the data<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n <<a title=\"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.\" class=\"dict\" href=\"message-definitions.htm#Message.responsible\"><b>responsible<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Final responsibility for event<\/span><span style=\"color: Gray\"> --><\/span></responsible>\r\n <<a title=\"The effective time - the real world time of the event that the message represents. Usually this is just a starting time, but some message events also have an end time (do x for period y).\" class=\"dict\" href=\"message-definitions.htm#Message.effective\"><b>effective<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time of effect<\/span><span style=\"color: Gray\"> --><\/span></effective>\r\n <<a title=\"Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.\" class=\"dict\" href=\"message-definitions.htm#Message.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-message-reason-encounter.htm\">Cause of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"The actual data of the message - a reference to the root/focus class of the event.\" class=\"dict\" href=\"message-definitions.htm#Message.data\"><b>data<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The actual content of the message<\/span><span style=\"color: Gray\"> --><\/span></data>\r\n</Message>\r\n<\/pre><\/div>"
},
"name":{
"value":"message"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. The root for a transmission either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle of which the Message resource instance is the first resource in the bundle."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Message"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Message"
},
"definition":{
"short":{
"value":"A message that contains resources"
},
"formal":{
"value":"The root for a transmission either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle of which the Message resource instance is the first resource in the bundle."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Message"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH / MSA / ERR"
}
}
]
}
},
{
"path":{
"value":"Message.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Message.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Message.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Message.identifier"
},
"definition":{
"short":{
"value":"Id of this message"
},
"formal":{
"value":"The identifier of this message."
},
"comments":{
"value":"This must be unique within the scope of this stream of messages."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Message.id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-10-message control ID"
}
}
]
}
},
{
"path":{
"value":"Message.timestamp"
},
"definition":{
"short":{
"value":"Time that the message was sent"
},
"formal":{
"value":"The time that the message was sent."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./creationTime[isNormalDatatype()]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-7-message date/time"
}
}
]
}
},
{
"path":{
"value":"Message.event"
},
"definition":{
"short":{
"value":"Code for the event this message represents"
},
"formal":{
"value":"Code that identifies the event this message represents and connects it with the event definition in the FHIR specification."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"MessageEvent"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-9.2-message type.trigger event"
}
}
]
}
},
{
"path":{
"value":"Message.response"
},
"definition":{
"short":{
"value":"If this is a reply to prior message"
},
"formal":{
"value":"Information about the message that this message is a response to. Only present if this message is a response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./conveyedAcknowledgement"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSA"
}
}
]
}
},
{
"path":{
"value":"Message.response.identifier"
},
"definition":{
"short":{
"value":"Id of original message"
},
"formal":{
"value":"The id of the message that this a response to."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./acknowledges.id[isNormalDatatype()]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSA-2-message control ID"
}
}
]
}
},
{
"path":{
"value":"Message.response.code"
},
"definition":{
"short":{
"value":"Type of response to the message"
},
"formal":{
"value":"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":{
"value":"This is a generic response to the request Message. Specific data for the response will be found in Message.data."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ResponseCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./typeCode[isNormalDatatype()]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSA-1-acknowledgment code"
}
}
]
}
},
{
"path":{
"value":"Message.response.details"
},
"definition":{
"short":{
"value":"Specific list of hints/warnings/errors"
},
"formal":{
"value":"Full details of any issues found in the message."
},
"comments":{
"value":"This must be contained in the bundle. If any of the issues are errors, the response code must be an error."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(OperationOutcome)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR"
}
}
]
}
},
{
"path":{
"value":"Message.source"
},
"definition":{
"short":{
"value":"Message Source Application"
},
"formal":{
"value":"The source application from which this message originated."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./communicationFunction[typeCode=\"SND\"])"
}
}
]
}
},
{
"path":{
"value":"Message.source.name"
},
"definition":{
"short":{
"value":"Name of system"
},
"formal":{
"value":"Human readable name for the target system."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-3-sending application"
}
}
]
}
},
{
"path":{
"value":"Message.source.software"
},
"definition":{
"short":{
"value":"Name of software running the system"
},
"formal":{
"value":"May include configuration or other information useful in debugging."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"SFT-3-software product name ( +SFT-1-software vendor organization)"
}
}
]
}
},
{
"path":{
"value":"Message.source.version"
},
"definition":{
"short":{
"value":"Version of software running"
},
"formal":{
"value":"Can convey versions of multiple systems in situations where a message passes through multiple hands."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"(Not supported)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"SFT-2-software certified version or release number"
}
}
]
}
},
{
"path":{
"value":"Message.source.contact"
},
"definition":{
"short":{
"value":"Human contact for problems"
},
"formal":{
"value":"An e-mail, phone, website or other contact point to use to resolve issues with message communications."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(MSH-22?)"
}
}
]
}
},
{
"path":{
"value":"Message.source.endpoint"
},
"definition":{
"short":{
"value":"Actual message source address or id"
},
"formal":{
"value":"Identifies the routing target to send acknowledgements to."
},
"comments":{
"value":"The id may be a non-resolvable URI for systems that do not use standard network-based addresses."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom[isNormalDatatype()]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-24-sending network address"
}
}
]
}
},
{
"path":{
"value":"Message.destination"
},
"definition":{
"short":{
"value":"Message Destination Application"
},
"formal":{
"value":"The destination application which the message is intended for."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./communicationFunction[typeCode=\"RCV\"]"
}
}
]
}
},
{
"path":{
"value":"Message.destination.name"
},
"definition":{
"short":{
"value":"Name of system"
},
"formal":{
"value":"Human readable name for the source system."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-5-receiving application"
}
}
]
}
},
{
"path":{
"value":"Message.destination.target"
},
"definition":{
"short":{
"value":"Particular delivery destination within the destination"
},
"formal":{
"value":"Identifies the target end system in situations where the initial message transmission is to an intermediary system."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]"
}
}
]
}
},
{
"path":{
"value":"Message.destination.endpoint"
},
"definition":{
"short":{
"value":"Actual destination address or id"
},
"formal":{
"value":"Indicates where the message should be routed to."
},
"comments":{
"value":"The id may be a non-resolvable URI for systems that do not use standard network-based addresses."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"MSH-25-receiving network address (or MSH-6-receiving facility by implication)"
}
}
]
}
},
{
"path":{
"value":"Message.enterer"
},
"definition":{
"short":{
"value":"The source of the data entry"
},
"formal":{
"value":"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":{
"value":"Usually only for the request, but can be used in a response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"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\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Message.author"
},
"definition":{
"short":{
"value":"The source of the decision"
},
"formal":{
"value":"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 Message. Can provide other authors in extensions."
},
"comments":{
"value":"Usually only for the request, but can be used in a response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"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\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-19-action by / PRT-5-Participation Person:PRT-4-Participation='AUT' / ROL where ROL.3 is IP or ORC.12"
}
}
]
}
},
{
"path":{
"value":"Message.receiver"
},
"definition":{
"short":{
"value":"Intended \"real-world\" recipient for the data"
},
"formal":{
"value":"Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-5-Participation Person:PRT-4-Participation='WAYR' / PRT-8-Participation Organization:PRT-4-Participation='WAYR'"
}
}
]
}
},
{
"path":{
"value":"Message.responsible"
},
"definition":{
"short":{
"value":"Final responsibility for event"
},
"formal":{
"value":"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":{
"value":"Usually only for the request, but can be used in a response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"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\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Message.effective"
},
"definition":{
"short":{
"value":"Time of effect"
},
"formal":{
"value":"The effective time - the real world time of the event that the message represents. Usually this is just a starting time, but some message events also have an end time (do x for period y)."
},
"comments":{
"value":"Usually only for the request, but can be used in a response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/effectiveTime[isNormalDatatype() and type=\"IVL_TS\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"EVN.3 or EVN.6 or ORC.15 / TQ1-7-start date/time + TQ1-8-end date/time"
}
}
]
}
},
{
"path":{
"value":"Message.reason"
},
"definition":{
"short":{
"value":"Cause of event"
},
"formal":{
"value":"Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"EventReason"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Message.data"
},
"definition":{
"short":{
"value":"The actual content of the message"
},
"formal":{
"value":"The actual data of the message - a reference to the root/focus class of the event."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"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)"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"MessageEvent"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/message-events"
}
}
},
{
"name":{
"value":"EventReason"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/message-reason-encounter"
}
}
},
{
"name":{
"value":"ResponseCode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/response-code"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"The root for a transmission either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle of which the Message resource instance is the first resource in the bundle.\" class=\"dict\" href=\"message-definitions.htm#Message\"><b>Message<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier of this message.\" class=\"dict\" href=\"message-definitions.htm#Message.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Id of this message<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The time that the message was sent.\" class=\"dict\" href=\"message-definitions.htm#Message.timestamp\"><b>timestamp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time that the message was sent<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the event this message represents and connects it with the event definition in the FHIR specification (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.event\"><span style=\"text-decoration: underline\"><b>event<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"message-events.htm\">Code for the event this message represents<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.response\"><span style=\"text-decoration: underline\"><b>response<\/b><\/span><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this is a reply to prior message --><\/span>\r\n <<a title=\"The id of the message that this a response to.\" class=\"dict\" href=\"message-definitions.htm#Message.response.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Id of original message<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"message-definitions.htm#Message.response.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"response-code.htm\">Type of response to the message<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Full details of any issues found in the message.\" class=\"dict\" href=\"message-definitions.htm#Message.response.details\"><b>details<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"operationoutcome.htm#OperationOutcome\">OperationOutcome<\/a>)<\/span> <span style=\"color: navy\">Specific list of hints/warnings/errors<\/span><span style=\"color: Gray\"> --><\/span></details>\r\n </response>\r\n <<a title=\"The source application from which this message originated.\" class=\"dict\" href=\"message-definitions.htm#Message.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Message Source Application --><\/span>\r\n <<a title=\"Human readable name for the target system.\" class=\"dict\" href=\"message-definitions.htm#Message.source.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"May include configuration or other information useful in debugging.\" class=\"dict\" href=\"message-definitions.htm#Message.source.software\"><b>software<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of software running the system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Can convey versions of multiple systems in situations where a message passes through multiple hands.\" class=\"dict\" href=\"message-definitions.htm#Message.source.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Version of software running<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An e-mail, phone, website or other contact point to use to resolve issues with message communications.\" class=\"dict\" href=\"message-definitions.htm#Message.source.contact\"><b>contact<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Human contact for problems<\/span><span style=\"color: Gray\"> --><\/span></contact>\r\n <<a title=\"Identifies the routing target to send acknowledgements to.\" class=\"dict\" href=\"message-definitions.htm#Message.source.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Actual message source address or id<\/span><span style=\"color: Gray\"> --><\/span>\r\n </source>\r\n <<a title=\"The destination application which the message is intended for.\" class=\"dict\" href=\"message-definitions.htm#Message.destination\"><b>destination<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Message Destination Application --><\/span>\r\n <<a title=\"Human readable name for the source system.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the target end system in situations where the initial message transmission is to an intermediary system.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Particular delivery destination within the destination<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"Indicates where the message should be routed to.\" class=\"dict\" href=\"message-definitions.htm#Message.destination.endpoint\"><b>endpoint<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Actual destination address or id<\/span><span style=\"color: Gray\"> --><\/span>\r\n </destination>\r\n <<a title=\"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.\" class=\"dict\" href=\"message-definitions.htm#Message.enterer\"><b>enterer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The source of the data entry<\/span><span style=\"color: Gray\"> --><\/span></enterer>\r\n <<a title=\"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 Message. Can provide other authors in extensions.\" class=\"dict\" href=\"message-definitions.htm#Message.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The source of the decision<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.\" class=\"dict\" href=\"message-definitions.htm#Message.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Intended "real-world" recipient for the data<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n <<a title=\"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.\" class=\"dict\" href=\"message-definitions.htm#Message.responsible\"><b>responsible<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Final responsibility for event<\/span><span style=\"color: Gray\"> --><\/span></responsible>\r\n <<a title=\"The effective time - the real world time of the event that the message represents. Usually this is just a starting time, but some message events also have an end time (do x for period y).\" class=\"dict\" href=\"message-definitions.htm#Message.effective\"><b>effective<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Time of effect<\/span><span style=\"color: Gray\"> --><\/span></effective>\r\n <<a title=\"Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.\" class=\"dict\" href=\"message-definitions.htm#Message.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-message-reason-encounter.htm\">Cause of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"The actual data of the message - a reference to the root/focus class of the event.\" class=\"dict\" href=\"message-definitions.htm#Message.data\"><b>data<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The actual content of the message<\/span><span style=\"color: Gray\"> --><\/span></data>\r\n</Message>\r\n<\/pre><\/div>"
},
{
"title":"\"observation\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/observation",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/observation.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Simple assertions and measurements made about a patient, device or other subject.\" class=\"dict\" href=\"observation-definitions.htm#Observation\"><b>Observation<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies what type of observation was performed.\" class=\"dict\" href=\"observation-definitions.htm#Observation.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.htm\">Kind of observation<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The information determined as a result of making the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#Attachment\">Attachment<\/a>|<a href=\"datatypes.htm#Ratio\">Ratio<\/a>|\r\n <a href=\"datatypes.htm#Choice\">Choice<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#SampledData\">SampledData<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Actual result<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"The assessment made based on the result of the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.interpretation\"><b>interpretation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-interpretation.htm\">High, low, normal, etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span></interpretation>\r\n <<a title=\"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.\" class=\"dict\" href=\"observation-definitions.htm#Observation.comments\"><b>comments<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about result<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"observation-definitions.htm#Observation.applies_x_\"><b>applies[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span> <span style=\"color: navy\">Relevant time/time-period<\/span><span style=\"color: Gray\"> --><\/span></applies[x]>\r\n <<a title=\"Date/Time this was made available.\" class=\"dict\" href=\"observation-definitions.htm#Observation.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date/Time this was made available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the result value (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.htm#Observation.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">Registered|Interim|Final|Amended|Cancelled|Withdrawn<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.htm#Observation.reliability\"><span style=\"text-decoration: underline\"><b>reliability<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-reliability.htm\">If quality issues exist (mostly devices)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates where on the subject's body the observation was made.\" class=\"dict\" href=\"observation-definitions.htm#Observation.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Observed body part<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"Indicates the mechanism used to perform the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-methods.htm\">How it was done<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"A unique identifier for the simple observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Observation id<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The thing the observation is being made about.\" class=\"dict\" href=\"observation-definitions.htm#Observation.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what this is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who was responsible for asserting the observed value as "true".\" class=\"dict\" href=\"observation-definitions.htm#Observation.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who did the observation<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Guidance on how to interpret the value by comparison to a normal or recommended range.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange\"><b>referenceRange<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Provides guide for interpretation --><\/span>\r\n <<a title=\"Code for the meaning of the reference range.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange.meaning\"><b>meaning<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-referencerange-meaning.htm\">The meaning of this range<\/a><\/span><span style=\"color: Gray\"> --><\/span></meaning>\r\n <<a title=\"Actual value of the reference range. May be a quantity (<20mg/L), a range (10-20 umol/L), or some text.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange.range_x_\"><b>range[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Reference<\/span><span style=\"color: Gray\"> --><\/span></range[x]>\r\n </referenceRange>\r\n <<a title=\"Component observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component\"><b>component<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: Must have at least one of value or components\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Component observation --><\/span>\r\n <<a title=\"Identifies what type of sub-observation was performed.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.htm\">Kind of component observation<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The information determined as a result of making the sub-observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#Attachment\">Attachment<\/a>|<a href=\"datatypes.htm#Ratio\">Ratio<\/a>|\r\n <a href=\"datatypes.htm#Choice\">Choice<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#SampledData\">SampledData<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Actual component result<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n </component>\r\n</Observation>\r\n<\/pre><\/div>"
},
"name":{
"value":"observation"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Simple assertions and measurements made about a patient, device or other subject."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Observation"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Observation"
},
"definition":{
"short":{
"value":"Simple observations"
},
"formal":{
"value":"Simple assertions and measurements made about a patient, device or other subject."
},
"comments":{
"value":"Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to describe aggregate collections of observations such as Lab reports, etc."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"normal range for quantity"
},
"severity":{
"value":"error"
},
"human":{
"value":"Can only have normal range if value is a quantity"
},
"xpath":{
"value":"exists(f:valueQuantity) or not(exists(f:normalRange))"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"value or components"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must have at least one of value or components"
},
"xpath":{
"value":"exists(*[starts-with(local-name(.), 'value')]) or exists(f:component)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Observation[isNormalAct() and subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and domainMember(\"SimpleObservationType\", code)]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX"
}
}
]
}
},
{
"path":{
"value":"Observation.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Observation.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Observation.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Observation.name"
},
"definition":{
"short":{
"value":"Kind of observation"
},
"formal":{
"value":"Identifies what type of observation was performed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ObservationType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-3-observation identifier"
}
}
]
}
},
{
"path":{
"value":"Observation.value[x]"
},
"definition":{
"short":{
"value":"Actual result"
},
"formal":{
"value":"The information determined as a result of making the observation."
},
"comments":{
"value":"The datatype for this element should be determined by Observation.name."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
},
{
"code":{
"value":"CodeableConcept"
}
},
{
"code":{
"value":"Attachment"
}
},
{
"code":{
"value":"Ratio"
}
},
{
"code":{
"value":"Choice"
}
},
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"SampledData"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./value"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX.2, OBX.5, OBX.6"
}
}
]
}
},
{
"path":{
"value":"Observation.interpretation"
},
"definition":{
"short":{
"value":"High, low, normal, etc."
},
"formal":{
"value":"The assessment made based on the result of the observation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ObservationInterpretation"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./interpretationCode)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-8-interpretation codes"
}
}
]
}
},
{
"path":{
"value":"Observation.comments"
},
"definition":{
"short":{
"value":"Comments about result"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"
}
}
]
}
},
{
"path":{
"value":"Observation.applies[x]"
},
"definition":{
"short":{
"value":"Relevant time/time-period"
},
"formal":{
"value":"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\"."
},
"comments":{
"value":"At least a date should be present unless this observation is a historical report."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./effectiveTime[type='IVL_TS' or type='TS']"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-14-date/time of the observation"
}
}
]
}
},
{
"path":{
"value":"Observation.issued"
},
"definition":{
"short":{
"value":"Date/Time this was made available"
},
"formal":{
"value":"Date/Time this was made available."
},
"comments":{
"value":"Updated when the result is updated."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR.22 (or MSH.7)"
}
}
]
}
},
{
"path":{
"value":"Observation.status"
},
"definition":{
"short":{
"value":"Registered|Interim|Final|Amended|Cancelled|Withdrawn"
},
"formal":{
"value":"The status of the result value."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ObservationStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-11-observation result status"
}
}
]
}
},
{
"path":{
"value":"Observation.reliability"
},
"definition":{
"short":{
"value":"If quality issues exist (mostly devices)"
},
"formal":{
"value":"An estimate of the degree to which quality issues have impacted on the value reported."
},
"comments":{
"value":"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. Interpreters of a result, whether human or machine, must always either be aware of the status, or prevented from using the observation without being unaware that the reliability is not \"ok\"."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ObservationReliability"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"Maybe OBX.8/OBX.9"
}
}
]
}
},
{
"path":{
"value":"Observation.bodySite"
},
"definition":{
"short":{
"value":"Observed body part"
},
"formal":{
"value":"Indicates where on the subject's body the observation was made."
},
"comments":{
"value":"Only used if not implicit in code found in Observation.name."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BodySite"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./targetSiteCode)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-20-observation site"
}
}
]
}
},
{
"path":{
"value":"Observation.method"
},
"definition":{
"short":{
"value":"How it was done"
},
"formal":{
"value":"Indicates the mechanism used to perform the observation."
},
"comments":{
"value":"Only used if not implicit in code for SimpleObservation.result.type."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ObservationMethod"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./methodCode)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-17-observation method"
}
}
]
}
},
{
"path":{
"value":"Observation.identifier"
},
"definition":{
"short":{
"value":"Observation id"
},
"formal":{
"value":"A unique identifier for the simple observation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./id[displayable=\"true\" and scope=\"OBJ\"])"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX.21"
}
}
]
}
},
{
"path":{
"value":"Observation.subject"
},
"definition":{
"short":{
"value":"Who/what this is about"
},
"formal":{
"value":"The thing the observation is being made about."
},
"comments":{
"value":"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 must be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isHighest(priorityCode) and typeCode=\"SBJ\" and isNormalParticipation()]/role\nor ./participation[isHighest(priorityCode) and typeCode=\"SBJ\" and isNormalParticipation()]/role/entity)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"Observation.performer"
},
"definition":{
"short":{
"value":"Who did the observation"
},
"formal":{
"value":"Who was responsible for asserting the observed value as \"true\"."
},
"comments":{
"value":"This would only be \"Device\" if the device is responsible for the measurement, not to capture the device used by a human to make the measurement. (The latter could be captured as an extension.)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Device|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isHighest(priorityCode) and typeCode=\"PRF\" and isNormalParticipation()]/role\nor\n./participation[isHighest(priorityCode) and typeCode=\"PRF\" and isNormalParticipation()]/role/entity]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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'"
}
}
]
}
},
{
"path":{
"value":"Observation.referenceRange"
},
"definition":{
"short":{
"value":"Provides guide for interpretation"
},
"formal":{
"value":"Guidance on how to interpret the value by comparison to a normal or recommended range."
},
"comments":{
"value":"Most results only have one reference range, might be generic or be specific to the patient's age, gender, weight and other factors. When these things are not known, multiple reference ranges may be provided."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"REFV\" and isNormalActRelationship()]/target[subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and isCriterionInd=\"true\" and isNormalAct()]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"Are multiple reference ranges in the 80%?"
}
}
]
}
},
{
"path":{
"value":"Observation.referenceRange.meaning"
},
"definition":{
"short":{
"value":"The meaning of this range"
},
"formal":{
"value":"Code for the meaning of the reference range."
},
"comments":{
"value":"This is only usually populated if there is more than one range."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ObservationRangeMeaning"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./interpretationCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-10-nature of abnormal test?"
}
}
]
}
},
{
"path":{
"value":"Observation.referenceRange.range[x]"
},
"definition":{
"short":{
"value":"Reference"
},
"formal":{
"value":"Actual value of the reference range. May be a quantity (<20mg/L), a range (10-20 umol/L), or some text."
},
"comments":{
"value":"Text reference ranges are typically used in endocrinology, or for legacy data with string reference ranges."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
},
{
"code":{
"value":"Range"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./value[type=(\"PQ\", \"IVL_PQ\", \"ST\")]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-7-references range"
}
}
]
}
},
{
"path":{
"value":"Observation.component"
},
"definition":{
"short":{
"value":"Component observation"
},
"formal":{
"value":"Component observation."
},
"comments":{
"value":"It would be usual to either have a value or components with values, but both may be used, such as for APGAR scores."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[typeCode=\"COMP\" and isNormalActRelationship()]/target[isNormalAct() and subsumesCode(\"ActClass#OBS\", classCode) and moodCode=\"EVN\" and fromDomain(code, \"SimpleObservationSubType\")]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"Child OBX by OBX.1/OBX.4, or by OBR structures"
}
}
]
}
},
{
"path":{
"value":"Observation.component.name"
},
"definition":{
"short":{
"value":"Kind of component observation"
},
"formal":{
"value":"Identifies what type of sub-observation was performed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ObservationType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX.3"
}
}
]
}
},
{
"path":{
"value":"Observation.component.value[x]"
},
"definition":{
"short":{
"value":"Actual component result"
},
"formal":{
"value":"The information determined as a result of making the sub-observation."
},
"comments":{
"value":"The datatype for this element should be determined by Observation.component.name."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
},
{
"code":{
"value":"CodeableConcept"
}
},
{
"code":{
"value":"Attachment"
}
},
{
"code":{
"value":"Ratio"
}
},
{
"code":{
"value":"Choice"
}
},
{
"code":{
"value":"Period"
}
},
{
"code":{
"value":"SampledData"
}
},
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./value"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX.2, OBX.5, OBX.6"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ObservationMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-methods"
}
}
},
{
"name":{
"value":"BodySite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/body-site"
}
}
},
{
"name":{
"value":"ObservationType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-codes"
}
}
},
{
"name":{
"value":"ObservationRangeMeaning"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/referencerange-meaning"
}
}
},
{
"name":{
"value":"ObservationReliability"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-reliability"
}
}
},
{
"name":{
"value":"ObservationStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-status"
}
}
},
{
"name":{
"value":"ObservationInterpretation"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-interpretation"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Simple assertions and measurements made about a patient, device or other subject.\" class=\"dict\" href=\"observation-definitions.htm#Observation\"><b>Observation<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies what type of observation was performed.\" class=\"dict\" href=\"observation-definitions.htm#Observation.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.htm\">Kind of observation<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The information determined as a result of making the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#Attachment\">Attachment<\/a>|<a href=\"datatypes.htm#Ratio\">Ratio<\/a>|\r\n <a href=\"datatypes.htm#Choice\">Choice<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#SampledData\">SampledData<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Actual result<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"The assessment made based on the result of the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.interpretation\"><b>interpretation<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-interpretation.htm\">High, low, normal, etc.<\/a><\/span><span style=\"color: Gray\"> --><\/span></interpretation>\r\n <<a title=\"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.\" class=\"dict\" href=\"observation-definitions.htm#Observation.comments\"><b>comments<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about result<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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".\" class=\"dict\" href=\"observation-definitions.htm#Observation.applies_x_\"><b>applies[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span> <span style=\"color: navy\">Relevant time/time-period<\/span><span style=\"color: Gray\"> --><\/span></applies[x]>\r\n <<a title=\"Date/Time this was made available.\" class=\"dict\" href=\"observation-definitions.htm#Observation.issued\"><b>issued<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date/Time this was made available<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The status of the result value (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.htm#Observation.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">Registered|Interim|Final|Amended|Cancelled|Withdrawn<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An estimate of the degree to which quality issues have impacted on the value reported (this element modifies the meaning of other elements)\" class=\"dict\" href=\"observation-definitions.htm#Observation.reliability\"><span style=\"text-decoration: underline\"><b>reliability<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-reliability.htm\">If quality issues exist (mostly devices)<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates where on the subject's body the observation was made.\" class=\"dict\" href=\"observation-definitions.htm#Observation.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Observed body part<\/a><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"Indicates the mechanism used to perform the observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-methods.htm\">How it was done<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"A unique identifier for the simple observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Observation id<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The thing the observation is being made about.\" class=\"dict\" href=\"observation-definitions.htm#Observation.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who/what this is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who was responsible for asserting the observed value as "true".\" class=\"dict\" href=\"observation-definitions.htm#Observation.performer\"><b>performer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who did the observation<\/span><span style=\"color: Gray\"> --><\/span></performer>\r\n <<a title=\"Guidance on how to interpret the value by comparison to a normal or recommended range.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange\"><b>referenceRange<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Provides guide for interpretation --><\/span>\r\n <<a title=\"Code for the meaning of the reference range.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange.meaning\"><b>meaning<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-referencerange-meaning.htm\">The meaning of this range<\/a><\/span><span style=\"color: Gray\"> --><\/span></meaning>\r\n <<a title=\"Actual value of the reference range. May be a quantity (<20mg/L), a range (10-20 umol/L), or some text.\" class=\"dict\" href=\"observation-definitions.htm#Observation.referenceRange.range_x_\"><b>range[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#Range\">Range<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Reference<\/span><span style=\"color: Gray\"> --><\/span></range[x]>\r\n </referenceRange>\r\n <<a title=\"Component observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component\"><b>component<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: Must have at least one of value or components\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Component observation --><\/span>\r\n <<a title=\"Identifies what type of sub-observation was performed.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-observation-codes.htm\">Kind of component observation<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"The information determined as a result of making the sub-observation.\" class=\"dict\" href=\"observation-definitions.htm#Observation.component.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a>|<a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a>|<a href=\"datatypes.htm#Attachment\">Attachment<\/a>|<a href=\"datatypes.htm#Ratio\">Ratio<\/a>|\r\n <a href=\"datatypes.htm#Choice\">Choice<\/a>|<a href=\"datatypes.htm#Period\">Period<\/a>|<a href=\"datatypes.htm#SampledData\">SampledData<\/a>|<a href=\"datatypes.htm#string\">string<\/a><\/span> <span style=\"color: navy\">Actual component result<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n </component>\r\n</Observation>\r\n<\/pre><\/div>"
},
{
"title":"\"operationoutcome\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/operationoutcome",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/operationoutcome.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A collection of error, warning or information messages that result from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome\"><b>OperationOutcome<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An error, warning or information message that results from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue\"><b>issue<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A single issue associated with the action --><\/span>\r\n <<a title=\"Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.severity\"><span style=\"text-decoration: underline\"><b>severity<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-severity.htm\">error | warning | information<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating the type of error, warning or information message.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-type.htm\">Error or warning code<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Additional description of the issue.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.details\"><b>details<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional description of the issue<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.location\"><b>location<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">XPath of element(s) related to issue<\/span><span style=\"color: Gray\"> --><\/span>\r\n </issue>\r\n</OperationOutcome>\r\n<\/pre><\/div>"
},
"name":{
"value":"operationoutcome"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A collection of error, warning or information messages that result from a system action."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"OperationOutcome"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"OperationOutcome"
},
"definition":{
"short":{
"value":"Information about the success/failure of an action"
},
"formal":{
"value":"A collection of error, warning or information messages that result from a system action."
},
"comments":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OperationOutcome.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OperationOutcome.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OperationOutcome.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OperationOutcome.issue"
},
"definition":{
"short":{
"value":"A single issue associated with the action"
},
"formal":{
"value":"An error, warning or information message that results from a system action."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR"
}
}
]
}
},
{
"path":{
"value":"OperationOutcome.issue.severity"
},
"definition":{
"short":{
"value":"error | warning | information"
},
"formal":{
"value":"Indicates whether the issue indicates a variation from successful processing."
},
"comments":{
"value":"This is labelled as \"Is Modifier\" because applications should not confuse hints and warnings with errors."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"IssueSeverity"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./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\"]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR-4"
}
}
]
}
},
{
"path":{
"value":"OperationOutcome.issue.type"
},
"definition":{
"short":{
"value":"Error or warning code"
},
"formal":{
"value":"A code indicating the type of error, warning or information message."
},
"comments":{
"value":"Codes should only be defined at a level of granularity that reasonably allows distinct actions to be taken by the receiving system. If the response behavior of all systems is the same for two codes, the codes might as well be merged. The human-meaningful content of the issue is conveyed in .text."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"IssueType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR-3, ERR-5"
}
}
]
}
},
{
"path":{
"value":"OperationOutcome.issue.details"
},
"definition":{
"short":{
"value":"Additional description of the issue"
},
"formal":{
"value":"Additional description of the issue."
},
"comments":{
"value":"typically this field is used to provide details human readable information about the error."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./text[parent::AcknowledgmentDetail]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR-8"
}
}
]
}
},
{
"path":{
"value":"OperationOutcome.issue.location"
},
"definition":{
"short":{
"value":"XPath of element(s) related to issue"
},
"formal":{
"value":"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":{
"value":"The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath must resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./location[parent::AcknowledgmentDetail]"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ERR-2"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"IssueType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/issue-type"
}
}
},
{
"name":{
"value":"IssueSeverity"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/issue-severity"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A collection of error, warning or information messages that result from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome\"><b>OperationOutcome<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An error, warning or information message that results from a system action.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue\"><b>issue<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A single issue associated with the action --><\/span>\r\n <<a title=\"Indicates whether the issue indicates a variation from successful processing (this element modifies the meaning of other elements)\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.severity\"><span style=\"text-decoration: underline\"><b>severity<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-severity.htm\">error | warning | information<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A code indicating the type of error, warning or information message.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"issue-type.htm\">Error or warning code<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Additional description of the issue.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.details\"><b>details<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional description of the issue<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"operationoutcome-definitions.htm#OperationOutcome.issue.location\"><b>location<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">XPath of element(s) related to issue<\/span><span style=\"color: Gray\"> --><\/span>\r\n </issue>\r\n</OperationOutcome>\r\n<\/pre><\/div>"
},
{
"title":"\"order\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/order",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/order.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A request to perform an action.\" class=\"dict\" href=\"order-definitions.htm#Order\"><b>Order<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"When the order was made.\" class=\"dict\" href=\"order-definitions.htm#Order.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the order was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Patient this order is about.\" class=\"dict\" href=\"order-definitions.htm#Order.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient this order is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who initiated the order.\" class=\"dict\" href=\"order-definitions.htm#Order.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who initiated the order<\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"Who is intended to fulfill the order.\" class=\"dict\" href=\"order-definitions.htm#Order.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who is intended to fulfill the order<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"Text - why the order was made.\" class=\"dict\" href=\"order-definitions.htm#Order.reason\"><b>reason<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text - why the order was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"order-definitions.htm#Order.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">If required by policy<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"When order should be fulfilled.\" class=\"dict\" href=\"order-definitions.htm#Order.when\"><b>when<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> When order should be fulfilled --><\/span>\r\n <<a title=\"Code specifies when request should be done. The code may simply be a priority code.\" class=\"dict\" href=\"order-definitions.htm#Order.when.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Code specifies when request should be done. The code may simply be a priority code<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A formal schedule.\" class=\"dict\" href=\"order-definitions.htm#Order.when.schedule\"><b>schedule<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">A formal schedule<\/span><span style=\"color: Gray\"> --><\/span></schedule>\r\n </when>\r\n <<a title=\"What action is being ordered.\" class=\"dict\" href=\"order-definitions.htm#Order.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">What action is being ordered<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n</Order>\r\n<\/pre><\/div>"
},
"name":{
"value":"order"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A request to perform an action."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Order"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Order"
},
"definition":{
"short":{
"value":"A request to perform an action"
},
"formal":{
"value":"A request to perform an action."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Order.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Order.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Order.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Order.date"
},
"definition":{
"short":{
"value":"When the order was made"
},
"formal":{
"value":"When the order was made."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-9"
}
}
]
}
},
{
"path":{
"value":"Order.subject"
},
"definition":{
"short":{
"value":"Patient this order is about"
},
"formal":{
"value":"Patient this order is about."
},
"comments":{
"value":"May be left blank if the request reference identifies the patient, or if the request is not associated with a patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3"
}
}
]
}
},
{
"path":{
"value":"Order.source"
},
"definition":{
"short":{
"value":"Who initiated the order"
},
"formal":{
"value":"Who initiated the order."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-12 / OBR-16 / RXO-14 / RXE-13 / PRT-5 (PRT-4-Participation='OP')"
}
}
]
}
},
{
"path":{
"value":"Order.target"
},
"definition":{
"short":{
"value":"Who is intended to fulfill the order"
},
"formal":{
"value":"Who is intended to fulfill the order."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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' })"
}
}
]
}
},
{
"path":{
"value":"Order.reason"
},
"definition":{
"short":{
"value":"Text - why the order was made"
},
"formal":{
"value":"Text - why the order was made."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Order.authority"
},
"definition":{
"short":{
"value":"If required by policy"
},
"formal":{
"value":"If required by policy."
},
"comments":{
"value":"reference will be constrained when suitable targets exist."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"if ordering provider, then ORC-12, OBR-16, etc."
}
}
]
}
},
{
"path":{
"value":"Order.when"
},
"definition":{
"short":{
"value":"When order should be fulfilled"
},
"formal":{
"value":"When order should be fulfilled."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"Scheduling Details"
},
"severity":{
"value":"error"
},
"human":{
"value":"Provide a code or a schedule, but not both"
},
"xpath":{
"value":"exists(f:code) != exists(f:schedule)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"TQ1, TQ2"
}
}
]
}
},
{
"path":{
"value":"Order.when.code"
},
"definition":{
"short":{
"value":"Code specifies when request should be done. The code may simply be a priority code"
},
"formal":{
"value":"Code specifies when request should be done. The code may simply be a priority code."
},
"comments":{
"value":"This is usually a local code agreed in the context of the ordering workflow."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"RequestedTime"
}
}
},
{
"path":{
"value":"Order.when.schedule"
},
"definition":{
"short":{
"value":"A formal schedule"
},
"formal":{
"value":"A formal schedule."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Schedule"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Order.detail"
},
"definition":{
"short":{
"value":"What action is being ordered"
},
"formal":{
"value":"What action is being ordered."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"RequestedTime"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"description":{
"value":"When a requested action should be performed"
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A request to perform an action.\" class=\"dict\" href=\"order-definitions.htm#Order\"><b>Order<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"When the order was made.\" class=\"dict\" href=\"order-definitions.htm#Order.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the order was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Patient this order is about.\" class=\"dict\" href=\"order-definitions.htm#Order.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient this order is about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Who initiated the order.\" class=\"dict\" href=\"order-definitions.htm#Order.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who initiated the order<\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"Who is intended to fulfill the order.\" class=\"dict\" href=\"order-definitions.htm#Order.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Who is intended to fulfill the order<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"Text - why the order was made.\" class=\"dict\" href=\"order-definitions.htm#Order.reason\"><b>reason<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text - why the order was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"order-definitions.htm#Order.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">If required by policy<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"When order should be fulfilled.\" class=\"dict\" href=\"order-definitions.htm#Order.when\"><b>when<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> When order should be fulfilled --><\/span>\r\n <<a title=\"Code specifies when request should be done. The code may simply be a priority code.\" class=\"dict\" href=\"order-definitions.htm#Order.when.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Code specifies when request should be done. The code may simply be a priority code<\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"A formal schedule.\" class=\"dict\" href=\"order-definitions.htm#Order.when.schedule\"><b>schedule<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Provide a code or a schedule, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Schedule\">Schedule<\/a><\/span> <span style=\"color: navy\">A formal schedule<\/span><span style=\"color: Gray\"> --><\/span></schedule>\r\n </when>\r\n <<a title=\"What action is being ordered.\" class=\"dict\" href=\"order-definitions.htm#Order.detail\"><b>detail<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">What action is being ordered<\/span><span style=\"color: Gray\"> --><\/span></detail>\r\n</Order>\r\n<\/pre><\/div>"
},
{
"title":"\"orderresponse\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/orderresponse",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/orderresponse.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A response to an order.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse\"><b>OrderResponse<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The order that this is a response to.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.request\"><b>request<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"order.htm#Order\">Order<\/a>)<\/span> <span style=\"color: navy\">The order that this is a response to<\/span><span style=\"color: Gray\"> --><\/span></request>\r\n <<a title=\"When the response was made.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the response was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who made the response.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.who\"><b>who<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who made the response<\/span><span style=\"color: Gray\"> --><\/span></who>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">If required by policy<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"How much the request will/did cost.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.cost\"><b>cost<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Money\">Money<\/a><\/span> <span style=\"color: navy\">How much the request will/did cost<\/span><span style=\"color: Gray\"> --><\/span></cost>\r\n <<a title=\"The status of the response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"order-outcome-code.htm\">The status of the response<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional description of the response.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional description of the response<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the outcome of performing the order.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.fulfillment\"><b>fulfillment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Details of the outcome of performing the order<\/span><span style=\"color: Gray\"> --><\/span></fulfillment>\r\n</OrderResponse>\r\n<\/pre><\/div>"
},
"name":{
"value":"orderresponse"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A response to an order."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"OrderResponse"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"OrderResponse"
},
"definition":{
"short":{
"value":"A response to an order"
},
"formal":{
"value":"A response to an order."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OrderResponse.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OrderResponse.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OrderResponse.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"OrderResponse.request"
},
"definition":{
"short":{
"value":"The order that this is a response to"
},
"formal":{
"value":"The order that this is a response to."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Order)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-2 / ORC-3"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.date"
},
"definition":{
"short":{
"value":"When the response was made"
},
"formal":{
"value":"When the response was made."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-9"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.who"
},
"definition":{
"short":{
"value":"Who made the response"
},
"formal":{
"value":"Who made the response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"Practitioner: ORC-19 / Organization: N/A"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.authority"
},
"definition":{
"short":{
"value":"If required by policy"
},
"formal":{
"value":"If required by policy."
},
"comments":{
"value":"reference will be constrained when suitable targets exist."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.cost"
},
"definition":{
"short":{
"value":"How much the request will/did cost"
},
"formal":{
"value":"How much the request will/did cost."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Money"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"unclear how this would map to V2; FT1 segment isn't explicitly provided for in order responses"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.code"
},
"definition":{
"short":{
"value":"The status of the response"
},
"formal":{
"value":"The status of the response."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"OrderOutcomeCode"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-1 + ORC-5"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.description"
},
"definition":{
"short":{
"value":"Additional description of the response"
},
"formal":{
"value":"Additional description of the response."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-16.2-order control code reason.text"
}
}
]
}
},
{
"path":{
"value":"OrderResponse.fulfillment"
},
"definition":{
"short":{
"value":"Details of the outcome of performing the order"
},
"formal":{
"value":"Details of the outcome of performing the order."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBR+OBX[n] / RXE / RXD / RXG / RXA / BPX / BTX"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"OrderOutcomeCode"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/order-outcome-code"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A response to an order.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse\"><b>OrderResponse<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The order that this is a response to.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.request\"><b>request<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"order.htm#Order\">Order<\/a>)<\/span> <span style=\"color: navy\">The order that this is a response to<\/span><span style=\"color: Gray\"> --><\/span></request>\r\n <<a title=\"When the response was made.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When the response was made<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Who made the response.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.who\"><b>who<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Who made the response<\/span><span style=\"color: Gray\"> --><\/span></who>\r\n <<a title=\"If required by policy.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.authority\"><b>authority<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">If required by policy<\/span><span style=\"color: Gray\"> --><\/span></authority>\r\n <<a title=\"How much the request will/did cost.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.cost\"><b>cost<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Money\">Money<\/a><\/span> <span style=\"color: navy\">How much the request will/did cost<\/span><span style=\"color: Gray\"> --><\/span></cost>\r\n <<a title=\"The status of the response (this element modifies the meaning of other elements)\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"order-outcome-code.htm\">The status of the response<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional description of the response.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional description of the response<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the outcome of performing the order.\" class=\"dict\" href=\"orderresponse-definitions.htm#OrderResponse.fulfillment\"><b>fulfillment<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Details of the outcome of performing the order<\/span><span style=\"color: Gray\"> --><\/span></fulfillment>\r\n</OrderResponse>\r\n<\/pre><\/div>"
},
{
"title":"\"organization\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/organization",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/organization.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"organization-definitions.htm#Organization\"><b>Organization<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier for the organization that is used to identify the organization across multiple disparate systems.\" class=\"dict\" href=\"organization-definitions.htm#Organization.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: The organization must at least have a name or an id, and possibly more\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier for this organization<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: The organization must at least have a name or an id, and possibly more\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name used for the organization<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of organization that this is.\" class=\"dict\" href=\"organization-definitions.htm#Organization.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-organization-type.htm\">Kind of organization<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"A contact detail for the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: The telecom of an organization can never be of use 'home'\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the organization<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"An address for the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: An address of an organization can never be of use 'home'\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">An address for the organization<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The organization of which this organization forms a part.\" class=\"dict\" href=\"organization-definitions.htm#Organization.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The organization of which this organization forms a part<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n <<a title=\"Contact for the organization for a certain purpose.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact\"><b>contact<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Contact for the organization --><\/span>\r\n <<a title=\"Indicates a purpose for which the contact can be reached.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.purpose\"><b>purpose<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-contactentity-type.htm\">The type of contact<\/a><\/span><span style=\"color: Gray\"> --><\/span></purpose>\r\n <<a title=\"A name associated with the contact.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the contact<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact details (telephone, email, etc) for a contact<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Visiting or postal addresses for the contact.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Visiting or postal addresses for the contact<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n </contact>\r\n <<a title=\"Whether the organization's record is still in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"organization-definitions.htm#Organization.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether the organization's record is still in active use<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Organization>\r\n<\/pre><\/div>"
},
"name":{
"value":"organization"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Organization"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Organization"
},
"definition":{
"short":{
"value":"A grouping of people or organizations with a common purpose"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"AtLeastANameOrId"
},
"severity":{
"value":"error"
},
"human":{
"value":"The organization must at least have a name or an id, and possibly more"
},
"xpath":{
"value":"count(f:identifier | f:name) > 0"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Organization(classCode=ORG, determinerCode=INST)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"(also see master files messages)"
}
}
]
}
},
{
"path":{
"value":"Organization.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Organization.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Organization.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Organization.identifier"
},
"definition":{
"short":{
"value":"Identifier for this organization"
},
"formal":{
"value":"Identifier for the organization that is used to identify the organization across multiple disparate systems."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".scopes[Role](classCode=IDENT)"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"XON.10 Organization Identifier / XON.3 ID Number"
}
}
]
}
},
{
"path":{
"value":"Organization.name"
},
"definition":{
"short":{
"value":"Name used for the organization"
},
"formal":{
"value":"A name associated with the organization."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"XON.1 Organization Name"
}
}
]
}
},
{
"path":{
"value":"Organization.type"
},
"definition":{
"short":{
"value":"Kind of organization"
},
"formal":{
"value":"The kind of organization that this is."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"OrganizationType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No equivalent in v2"
}
}
]
}
},
{
"path":{
"value":"Organization.telecom"
},
"definition":{
"short":{
"value":"A contact detail for the organization"
},
"formal":{
"value":"A contact detail for the organization."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"NoHomeUseTelecom"
},
"severity":{
"value":"error"
},
"human":{
"value":"The telecom of an organization can never be of use 'home'"
},
"xpath":{
"value":"count(f:use[@value='home']) = 0"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No authoritative equivalent in V2.x"
}
}
]
}
},
{
"path":{
"value":"Organization.address"
},
"definition":{
"short":{
"value":"An address for the organization"
},
"formal":{
"value":"An address for the organization."
},
"comments":{
"value":"Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"NoHomeUseAddress"
},
"severity":{
"value":"error"
},
"human":{
"value":"An address of an organization can never be of use 'home'"
},
"xpath":{
"value":"count(f:use[@value='home']) = 0"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".address"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No authoritative equivalent in V2.x; some V2.x segments such as OBX might provide a serialized instance value"
}
}
]
}
},
{
"path":{
"value":"Organization.partOf"
},
"definition":{
"short":{
"value":"The organization of which this organization forms a part"
},
"formal":{
"value":"The organization of which this organization forms a part."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No equivalent in V2.x"
}
}
]
}
},
{
"path":{
"value":"Organization.contact"
},
"definition":{
"short":{
"value":"Contact for the organization"
},
"formal":{
"value":"Contact for the organization for a certain purpose."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".contactParty"
}
}
]
}
},
{
"path":{
"value":"Organization.contact.purpose"
},
"definition":{
"short":{
"value":"The type of contact"
},
"formal":{
"value":"Indicates a purpose for which the contact can be reached."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ContactPartyType"
}
}
},
{
"path":{
"value":"Organization.contact.name"
},
"definition":{
"short":{
"value":"A name associated with the contact"
},
"formal":{
"value":"A name associated with the contact."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-5, PID-9"
}
}
]
}
},
{
"path":{
"value":"Organization.contact.telecom"
},
"definition":{
"short":{
"value":"Contact details (telephone, email, etc) for a contact"
},
"formal":{
"value":"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-13, PID-14"
}
}
]
}
},
{
"path":{
"value":"Organization.contact.address"
},
"definition":{
"short":{
"value":"Visiting or postal addresses for the contact"
},
"formal":{
"value":"Visiting or postal addresses for the contact."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./addr"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-11"
}
}
]
}
},
{
"path":{
"value":"Organization.contact.gender"
},
"definition":{
"short":{
"value":"Gender for administrative purposes"
},
"formal":{
"value":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdministrativeGender"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./administrativeGender"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-8"
}
}
]
}
},
{
"path":{
"value":"Organization.active"
},
"definition":{
"short":{
"value":"Whether the organization's record is still in active use"
},
"formal":{
"value":"Whether the organization's record is still in active use."
},
"comments":{
"value":"Default is true."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".status"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"No equivalent in V2.x"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"AdministrativeGender"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administrative-gender"
}
}
},
{
"name":{
"value":"OrganizationType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/organization-type"
}
}
},
{
"name":{
"value":"ContactPartyType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/contactentity-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"organization-definitions.htm#Organization\"><b>Organization<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier for the organization that is used to identify the organization across multiple disparate systems.\" class=\"dict\" href=\"organization-definitions.htm#Organization.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: The organization must at least have a name or an id, and possibly more\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier for this organization<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: The organization must at least have a name or an id, and possibly more\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name used for the organization<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The kind of organization that this is.\" class=\"dict\" href=\"organization-definitions.htm#Organization.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-organization-type.htm\">Kind of organization<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"A contact detail for the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: The telecom of an organization can never be of use 'home'\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the organization<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"An address for the organization.\" class=\"dict\" href=\"organization-definitions.htm#Organization.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: An address of an organization can never be of use 'home'\" style=\"color: deeppink\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">An address for the organization<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"The organization of which this organization forms a part.\" class=\"dict\" href=\"organization-definitions.htm#Organization.partOf\"><b>partOf<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The organization of which this organization forms a part<\/span><span style=\"color: Gray\"> --><\/span></partOf>\r\n <<a title=\"Contact for the organization for a certain purpose.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact\"><b>contact<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Contact for the organization --><\/span>\r\n <<a title=\"Indicates a purpose for which the contact can be reached.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.purpose\"><b>purpose<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-contactentity-type.htm\">The type of contact<\/a><\/span><span style=\"color: Gray\"> --><\/span></purpose>\r\n <<a title=\"A name associated with the contact.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the contact<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact details (telephone, email, etc) for a contact<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Visiting or postal addresses for the contact.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Visiting or postal addresses for the contact<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"organization-definitions.htm#Organization.contact.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n </contact>\r\n <<a title=\"Whether the organization's record is still in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"organization-definitions.htm#Organization.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether the organization's record is still in active use<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Organization>\r\n<\/pre><\/div>"
},
{
"title":"\"other\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/other",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/other.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.\" class=\"dict\" href=\"other-definitions.htm#Other\"><b>Other<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)\" class=\"dict\" href=\"other-definitions.htm#Other.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-other-resource-type.htm\">Kind of Resource<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce.\" class=\"dict\" href=\"other-definitions.htm#Other.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Identifies the<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Indicates who was responsible for creating the resource instance.\" class=\"dict\" href=\"other-definitions.htm#Other.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">Who created<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Identifies when the resource was first created.\" class=\"dict\" href=\"other-definitions.htm#Other.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When created<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Other>\r\n<\/pre><\/div>"
},
"name":{
"value":"other"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Other"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Other"
},
"definition":{
"short":{
"value":"Resource for non-supported content"
},
"formal":{
"value":"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Act, Entity or Role"
}
}
]
}
},
{
"path":{
"value":"Other.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Other.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Other.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Other.code"
},
"definition":{
"short":{
"value":"Kind of Resource"
},
"formal":{
"value":"Identifies the 'type' of resource - equivalent to the resource name for other resources."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"OtherResourceType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Other.subject"
},
"definition":{
"short":{
"value":"Identifies the"
},
"formal":{
"value":"Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce."
},
"comments":{
"value":"Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
}
}
]
}
},
{
"path":{
"value":"Other.author"
},
"definition":{
"short":{
"value":"Who created"
},
"formal":{
"value":"Indicates who was responsible for creating the resource instance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient|RelatedPerson)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
}
}
]
}
},
{
"path":{
"value":"Other.created"
},
"definition":{
"short":{
"value":"When created"
},
"formal":{
"value":"Identifies when the resource was first created."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"date"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"OtherResourceType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/other-resource-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.\" class=\"dict\" href=\"other-definitions.htm#Other\"><b>Other<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)\" class=\"dict\" href=\"other-definitions.htm#Other.code\"><span style=\"text-decoration: underline\"><b>code<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-other-resource-type.htm\">Kind of Resource<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce.\" class=\"dict\" href=\"other-definitions.htm#Other.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Identifies the<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Indicates who was responsible for creating the resource instance.\" class=\"dict\" href=\"other-definitions.htm#Other.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">Who created<\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"Identifies when the resource was first created.\" class=\"dict\" href=\"other-definitions.htm#Other.created\"><b>created<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#date\">date<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">When created<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Other>\r\n<\/pre><\/div>"
},
{
"title":"\"patient\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/patient",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/patient.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Demographics and other administrative information about a person or animal receiving care or other health-related services.\" class=\"dict\" href=\"patient-definitions.htm#Patient\"><b>Patient<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An identifier that applies to this person as a patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the person as this patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.\" class=\"dict\" href=\"patient-definitions.htm#Patient.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.htm#Patient.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"The date and time of birth for the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.birthDate\"><b>birthDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time of birth for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates if the individual is deceased or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.deceased_x_\"><span style=\"text-decoration: underline\"><b>deceased[x]<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span> <span style=\"color: navy\">Indicates if the individual is deceased or not<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></deceased[x]>\r\n <<a title=\"Addresses for the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Addresses for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"This field contains a patient's most recent marital (civil) status.\" class=\"dict\" href=\"patient-definitions.htm#Patient.maritalStatus\"><b>maritalStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-marital-status.htm\">Marital (civil) status of a person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></maritalStatus>\r\n <<a title=\"Indicates whether the patient is part of a multiple or indicates the actual birth order.\" class=\"dict\" href=\"patient-definitions.htm#Patient.multipleBirth_x_\"><b>multipleBirth[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#integer\">integer<\/a><\/span> <span style=\"color: navy\">Whether patient is part of a multiple birth<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></multipleBirth[x]>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n <<a title=\"A contact party (e.g. guardian, partner, friend) for the patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact\"><b>contact<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A contact party (e.g. guardian, partner, friend) for the patient --><\/span>\r\n <<a title=\"The nature of the relationship between the patient and the contact person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-patient-contact-relationship.htm\">The kind of relationship<\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the person<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Address for the contact person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Address for the contact person<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"Organization on behalf of which the contact is acting or for which the contact is working.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.organization\"><b>organization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must at least contain a contact's details or a reference to an organization\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization that is associated with the contact<\/span><span style=\"color: Gray\"> --><\/span></organization>\r\n </contact>\r\n <<a title=\"This element has a value if the patient is an animal (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal\"><span style=\"text-decoration: underline\"><b>animal<\/b><\/span><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this patient is an animal (non-human)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Identifies the high level categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.species\"><b>species<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-species.htm\">E.g. Dog, Cow<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></species>\r\n <<a title=\"Identifies the detailed categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.breed\"><b>breed<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-breeds.htm\">E.g. Poodle, Angus<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></breed>\r\n <<a title=\"Indicates the current state of the animal's reproductive organs.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.genderStatus\"><b>genderStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-genderstatus.htm\">E.g. Neutered, Intact<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></genderStatus>\r\n </animal>\r\n <<a title=\"Languages which may be used to communicate with the patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.communication\"><b>communication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">Languages which may be used to communicate with the patient<\/a><\/span><span style=\"color: Gray\"> --><\/span></communication>\r\n <<a title=\"The provider for whom this is a patient record.\" class=\"dict\" href=\"patient-definitions.htm#Patient.provider\"><b>provider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization managing the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></provider>\r\n <<a title=\"A linked patient resource is a resource that concerns the same patient. Resources are linked after it is realized that at least one was created in error (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.link\"><span style=\"text-decoration: underline\"><b>link<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Other patient resources linked to this resource<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></link>\r\n <<a title=\"Whether this patient record is in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether this patient's record is in active use<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n</Patient>\r\n<\/pre><\/div>"
},
"name":{
"value":"patient"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Demographics and other administrative information about a person or animal receiving care or other health-related services."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Patient"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Patient"
},
"definition":{
"short":{
"value":"Information about a person or animal receiving health care services"
},
"formal":{
"value":"Demographics and other administrative information about a person or animal receiving care or other health-related services."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Patient"
}
}
]
}
},
{
"path":{
"value":"Patient.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.identifier"
},
"definition":{
"short":{
"value":"An identifier for the person as this patient"
},
"formal":{
"value":"An identifier that applies to this person as a patient."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3"
}
}
]
}
},
{
"path":{
"value":"Patient.name"
},
"definition":{
"short":{
"value":"A name associated with the patient"
},
"formal":{
"value":"A name associated with the individual."
},
"comments":{
"value":"Person 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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-5, PID-9"
}
}
]
}
},
{
"path":{
"value":"Patient.telecom"
},
"definition":{
"short":{
"value":"A contact detail for the individual"
},
"formal":{
"value":"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted."
},
"comments":{
"value":"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. 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)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-13, PID-14, PID-40"
}
}
]
}
},
{
"path":{
"value":"Patient.gender"
},
"definition":{
"short":{
"value":"Gender for administrative purposes"
},
"formal":{
"value":"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdministrativeGender"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./administrativeGender"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-8"
}
}
]
}
},
{
"path":{
"value":"Patient.birthDate"
},
"definition":{
"short":{
"value":"The date and time of birth for the individual"
},
"formal":{
"value":"The date and time of birth for the individual."
},
"comments":{
"value":"At least an estimated year should be provided as a guess if the real dob is unknown."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./birthTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-7"
}
}
]
}
},
{
"path":{
"value":"Patient.deceased[x]"
},
"definition":{
"short":{
"value":"Indicates if the individual is deceased or not"
},
"formal":{
"value":"Indicates if the individual is deceased or not."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
},
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./deceasedInd"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-30"
}
}
]
}
},
{
"path":{
"value":"Patient.address"
},
"definition":{
"short":{
"value":"Addresses for the individual"
},
"formal":{
"value":"Addresses for the individual."
},
"comments":{
"value":"Person may have multiple addresses with different uses or applicable periods."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./addr"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-11"
}
}
]
}
},
{
"path":{
"value":"Patient.maritalStatus"
},
"definition":{
"short":{
"value":"Marital (civil) status of a person"
},
"formal":{
"value":"This field contains a patient's most recent marital (civil) status."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"MaritalStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./maritalStatus"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-16"
}
}
]
}
},
{
"path":{
"value":"Patient.multipleBirth[x]"
},
"definition":{
"short":{
"value":"Whether patient is part of a multiple birth"
},
"formal":{
"value":"Indicates whether the patient is part of a multiple or indicates the actual birth order."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
},
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".multipleBirthInd"
}
}
]
}
},
{
"path":{
"value":"Patient.photo"
},
"definition":{
"short":{
"value":"Image of the person"
},
"formal":{
"value":"Image of the person."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.contact"
},
"definition":{
"short":{
"value":"A contact party (e.g. guardian, partner, friend) for the patient"
},
"formal":{
"value":"A contact party (e.g. guardian, partner, friend) for the patient."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"ContactNeedsDetails"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must at least contain a contact's details or a reference to an organization"
},
"xpath":{
"value":"f:name or f:telecom or f:address or f:organization"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.contact.relationship"
},
"definition":{
"short":{
"value":"The kind of relationship"
},
"formal":{
"value":"The nature of the relationship between the patient and the contact person."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ContactRelationship"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-3-relationship"
}
}
]
}
},
{
"path":{
"value":"Patient.contact.name"
},
"definition":{
"short":{
"value":"A name associated with the person"
},
"formal":{
"value":"A name associated with the person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-5, PID-9"
}
}
]
}
},
{
"path":{
"value":"Patient.contact.telecom"
},
"definition":{
"short":{
"value":"A contact detail for the person"
},
"formal":{
"value":"A contact detail for the person, e.g. a telephone number or an email address."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-13, PID-14"
}
}
]
}
},
{
"path":{
"value":"Patient.contact.address"
},
"definition":{
"short":{
"value":"Address for the contact person"
},
"formal":{
"value":"Address for the contact person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./addr"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-11"
}
}
]
}
},
{
"path":{
"value":"Patient.contact.gender"
},
"definition":{
"short":{
"value":"Gender for administrative purposes"
},
"formal":{
"value":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdministrativeGender"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./administrativeGender"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-8"
}
}
]
}
},
{
"path":{
"value":"Patient.contact.organization"
},
"definition":{
"short":{
"value":"Organization that is associated with the contact"
},
"formal":{
"value":"Organization on behalf of which the contact is acting or for which the contact is working."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.animal"
},
"definition":{
"short":{
"value":"If this patient is an animal (non-human)"
},
"formal":{
"value":"This element has a value if the patient is an animal."
},
"comments":{
"value":"The animal element is labelled \"Is Modifier\" since patients may be non-human. Systems must either handle patient details appropriately (e.g. inform users patient is not human) or reject non-human patient records."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":true
}
}
},
{
"path":{
"value":"Patient.animal.species"
},
"definition":{
"short":{
"value":"E.g. Dog, Cow"
},
"formal":{
"value":"Identifies the high level categorization of the kind of animal."
},
"comments":{
"value":"If the patient is non-human, at least a species must be specified."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AnimalSpecies"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".playedRole[classCode=GEN].scoper[classCode=ANM, determinerCode=KIND].code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID.35"
}
}
]
}
},
{
"path":{
"value":"Patient.animal.breed"
},
"definition":{
"short":{
"value":"E.g. Poodle, Angus"
},
"formal":{
"value":"Identifies the detailed categorization of the kind of animal."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AnimalBreed"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".code"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID.37"
}
}
]
}
},
{
"path":{
"value":"Patient.animal.genderStatus"
},
"definition":{
"short":{
"value":"E.g. Neutered, Intact"
},
"formal":{
"value":"Indicates the current state of the animal's reproductive organs."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AnimalGenderStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".genderStatusCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"N/A"
}
}
]
}
},
{
"path":{
"value":"Patient.communication"
},
"definition":{
"short":{
"value":"Languages which may be used to communicate with the patient"
},
"formal":{
"value":"Languages which may be used to communicate with the patient."
},
"comments":{
"value":"If no language is specified, this *implies* that the default local language is spoken.\nFor animals, language is not a relevant field, and should be absent from the instance."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Language"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".LanguageCommunication"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"LAN"
}
}
]
}
},
{
"path":{
"value":"Patient.provider"
},
"definition":{
"short":{
"value":"Organization managing the patient"
},
"formal":{
"value":"The provider for whom this is a patient record."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Patient.link"
},
"definition":{
"short":{
"value":"Other patient resources linked to this resource"
},
"formal":{
"value":"A linked patient resource is a resource that concerns the same patient. Resources are linked after it is realized that at least one was created in error."
},
"comments":{
"value":"More then two patient resources may be linked. Note that there is a special transaction for linking patient resources in the RESTful context, as resource linking consistency must be maintained."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3-patient ID list"
}
}
]
}
},
{
"path":{
"value":"Patient.active"
},
"definition":{
"short":{
"value":"Whether this patient's record is in active use"
},
"formal":{
"value":"Whether this patient record is in active use."
},
"comments":{
"value":"Default is true. If a record is inactive, and linked to an active record, then future patient/person/record updates should occur on the other patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./status"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"AnimalGenderStatus"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/animal-genderstatus"
}
}
},
{
"name":{
"value":"AdministrativeGender"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administrative-gender"
}
}
},
{
"name":{
"value":"AnimalBreed"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/animal-breeds"
}
}
},
{
"name":{
"value":"Language"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://tools.ietf.org/html/bcp47"
}
},
{
"name":{
"value":"AnimalSpecies"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/animal-species"
}
}
},
{
"name":{
"value":"ContactRelationship"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/patient-contact-relationship"
}
}
},
{
"name":{
"value":"MaritalStatus"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/marital-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Demographics and other administrative information about a person or animal receiving care or other health-related services.\" class=\"dict\" href=\"patient-definitions.htm#Patient\"><b>Patient<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An identifier that applies to this person as a patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">An identifier for the person as this patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.\" class=\"dict\" href=\"patient-definitions.htm#Patient.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.htm#Patient.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"The date and time of birth for the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.birthDate\"><b>birthDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time of birth for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates if the individual is deceased or not (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.deceased_x_\"><span style=\"text-decoration: underline\"><b>deceased[x]<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span> <span style=\"color: navy\">Indicates if the individual is deceased or not<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></deceased[x]>\r\n <<a title=\"Addresses for the individual.\" class=\"dict\" href=\"patient-definitions.htm#Patient.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Addresses for the individual<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"This field contains a patient's most recent marital (civil) status.\" class=\"dict\" href=\"patient-definitions.htm#Patient.maritalStatus\"><b>maritalStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-marital-status.htm\">Marital (civil) status of a person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></maritalStatus>\r\n <<a title=\"Indicates whether the patient is part of a multiple or indicates the actual birth order.\" class=\"dict\" href=\"patient-definitions.htm#Patient.multipleBirth_x_\"><b>multipleBirth[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a>|<a href=\"datatypes.htm#integer\">integer<\/a><\/span> <span style=\"color: navy\">Whether patient is part of a multiple birth<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></multipleBirth[x]>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n <<a title=\"A contact party (e.g. guardian, partner, friend) for the patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact\"><b>contact<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A contact party (e.g. guardian, partner, friend) for the patient --><\/span>\r\n <<a title=\"The nature of the relationship between the patient and the contact person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-patient-contact-relationship.htm\">The kind of relationship<\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the person<\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Address for the contact person.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Address for the contact person<\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"Organization on behalf of which the contact is acting or for which the contact is working.\" class=\"dict\" href=\"patient-definitions.htm#Patient.contact.organization\"><b>organization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must at least contain a contact's details or a reference to an organization\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization that is associated with the contact<\/span><span style=\"color: Gray\"> --><\/span></organization>\r\n </contact>\r\n <<a title=\"This element has a value if the patient is an animal (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal\"><span style=\"text-decoration: underline\"><b>animal<\/b><\/span><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this patient is an animal (non-human)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"Identifies the high level categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.species\"><b>species<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-species.htm\">E.g. Dog, Cow<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></species>\r\n <<a title=\"Identifies the detailed categorization of the kind of animal.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.breed\"><b>breed<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-breeds.htm\">E.g. Poodle, Angus<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></breed>\r\n <<a title=\"Indicates the current state of the animal's reproductive organs.\" class=\"dict\" href=\"patient-definitions.htm#Patient.animal.genderStatus\"><b>genderStatus<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-animal-genderstatus.htm\">E.g. Neutered, Intact<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></genderStatus>\r\n </animal>\r\n <<a title=\"Languages which may be used to communicate with the patient.\" class=\"dict\" href=\"patient-definitions.htm#Patient.communication\"><b>communication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">Languages which may be used to communicate with the patient<\/a><\/span><span style=\"color: Gray\"> --><\/span></communication>\r\n <<a title=\"The provider for whom this is a patient record.\" class=\"dict\" href=\"patient-definitions.htm#Patient.provider\"><b>provider<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization managing the patient<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></provider>\r\n <<a title=\"A linked patient resource is a resource that concerns the same patient. Resources are linked after it is realized that at least one was created in error (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.link\"><span style=\"text-decoration: underline\"><b>link<\/b><\/span><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Other patient resources linked to this resource<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></link>\r\n <<a title=\"Whether this patient record is in active use (this element modifies the meaning of other elements)\" class=\"dict\" href=\"patient-definitions.htm#Patient.active\"><span style=\"text-decoration: underline\"><b>active<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Whether this patient's record is in active use<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n</Patient>\r\n<\/pre><\/div>"
},
{
"title":"\"practitioner\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/practitioner",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/practitioner.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Demographics and qualification information for an individual who is directly or indirectly involved in the provisioning of healthcare.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner\"><b>Practitioner<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An identifier that applies to this person in this role.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">A identifier for the person as this agent<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the practitioner, e.g. a telephone number or an email address.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"One or more addresses where the practitioner can be found or visited.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">One or more addresses for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"The date and time of birth for the practitioner.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.birthDate\"><b>birthDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time of birth for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n <<a title=\"The organization that the practitioner represents.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.organization\"><b>organization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The represented organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></organization>\r\n <<a title=\"The way in which the person represents the organization - what role do they have?.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-role.htm\">A role the practitioner has<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"Specific specialty of the practitioner.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.specialty\"><b>specialty<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-specialty.htm\">Specific specialty of the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></specialty>\r\n <<a title=\"The period during which the person is authorized to perform the service.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The period during which the person is authorized to perform the service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Qualifications relevant to the provided service.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification\"><b>qualification<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Qualifications relevant to the provided service --><\/span>\r\n <<a title=\"Coded representation of the qualification.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-anzsco-occupations.htm\">Qualification<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Period during which the qualification is valid.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period during which the qualification is valid<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Organization that regulates and issues the qualification.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.issuer\"><b>issuer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization that regulates and issues the qualification<\/span><span style=\"color: Gray\"> --><\/span></issuer>\r\n </qualification>\r\n <<a title=\"A language the practitioner is able to use in patient communication.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.communication\"><b>communication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">A language the practitioner is able to use in patient communication<\/a><\/span><span style=\"color: Gray\"> --><\/span></communication>\r\n</Practitioner>\r\n<\/pre><\/div>"
},
"name":{
"value":"practitioner"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Demographics and qualification information for an individual who is directly or indirectly involved in the provisioning of healthcare."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Practitioner"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Practitioner"
},
"definition":{
"short":{
"value":"A person with a formal responsibility in the provisioning of healthcare or related services"
},
"formal":{
"value":"Demographics and qualification information for an individual who is directly or indirectly involved in the provisioning of healthcare."
},
"comments":{
"value":"Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Role"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRD (as one example)"
}
}
]
}
},
{
"path":{
"value":"Practitioner.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.identifier"
},
"definition":{
"short":{
"value":"A identifier for the person as this agent"
},
"formal":{
"value":"An identifier that applies to this person in this role."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRD-7 (or XCN.1 Person Identifier)"
}
}
]
}
},
{
"path":{
"value":"Practitioner.name"
},
"definition":{
"short":{
"value":"A name associated with the person"
},
"formal":{
"value":"A name associated with the person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"XCN Components"
}
}
]
}
},
{
"path":{
"value":"Practitioner.telecom"
},
"definition":{
"short":{
"value":"A contact detail for the practitioner"
},
"formal":{
"value":"A contact detail for the practitioner, e.g. a telephone number or an email address."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRT-15, STF-10, ROL-12"
}
}
]
}
},
{
"path":{
"value":"Practitioner.address"
},
"definition":{
"short":{
"value":"One or more addresses for the practitioner"
},
"formal":{
"value":"One or more addresses where the practitioner can be found or visited."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./addr"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"ORC-24, STF-11, ROL-11, PRT-14"
}
}
]
}
},
{
"path":{
"value":"Practitioner.gender"
},
"definition":{
"short":{
"value":"Gender for administrative purposes"
},
"formal":{
"value":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdministrativeGender"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./administrativeGender"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"STF-5"
}
}
]
}
},
{
"path":{
"value":"Practitioner.birthDate"
},
"definition":{
"short":{
"value":"The date and time of birth for the practitioner"
},
"formal":{
"value":"The date and time of birth for the practitioner."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./birthTime"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"STF-6"
}
}
]
}
},
{
"path":{
"value":"Practitioner.photo"
},
"definition":{
"short":{
"value":"Image of the person"
},
"formal":{
"value":"Image of the person."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.organization"
},
"definition":{
"short":{
"value":"The represented organization"
},
"formal":{
"value":"The organization that the practitioner represents."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRD-10 (-> 14) / PRA-9-Institution / PRT-8-Participation Organization for person participation"
}
}
]
}
},
{
"path":{
"value":"Practitioner.role"
},
"definition":{
"short":{
"value":"A role the practitioner has"
},
"formal":{
"value":"The way in which the person represents the organization - what role do they have?."
},
"comments":{
"value":"A person may have more than one role. At least one role is required."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"PractitionerRole"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"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"
}
}
]
}
},
{
"path":{
"value":"Practitioner.specialty"
},
"definition":{
"short":{
"value":"Specific specialty of the practitioner"
},
"formal":{
"value":"Specific specialty of the practitioner."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"PractitionerSpecialty"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRA-5-specialty"
}
}
]
}
},
{
"path":{
"value":"Practitioner.period"
},
"definition":{
"short":{
"value":"The period during which the person is authorized to perform the service"
},
"formal":{
"value":"The period during which the person is authorized to perform the service."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PRD-8/9 / PRA-5.4-date of certification"
}
}
]
}
},
{
"path":{
"value":"Practitioner.qualification"
},
"definition":{
"short":{
"value":"Qualifications relevant to the provided service"
},
"formal":{
"value":"Qualifications relevant to the provided service."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"CER?"
}
}
]
}
},
{
"path":{
"value":"Practitioner.qualification.code"
},
"definition":{
"short":{
"value":"Qualification"
},
"formal":{
"value":"Coded representation of the qualification."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Qualification"
}
}
},
{
"path":{
"value":"Practitioner.qualification.period"
},
"definition":{
"short":{
"value":"Period during which the qualification is valid"
},
"formal":{
"value":"Period during which the qualification is valid."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.qualification.issuer"
},
"definition":{
"short":{
"value":"Organization that regulates and issues the qualification"
},
"formal":{
"value":"Organization that regulates and issues the qualification."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Organization)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Practitioner.communication"
},
"definition":{
"short":{
"value":"A language the practitioner is able to use in patient communication"
},
"formal":{
"value":"A language the practitioner is able to use in patient communication."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"Language"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./languageCode"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-15, NK1-20, LAN-2"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"Qualification"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/anzsco-occupations"
}
}
},
{
"name":{
"value":"AdministrativeGender"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administrative-gender"
}
}
},
{
"name":{
"value":"Language"
},
"conformance":{
"value":"required"
},
"referenceUri":{
"value":"http://tools.ietf.org/html/bcp47"
}
},
{
"name":{
"value":"PractitionerSpecialty"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/practitioner-specialty"
}
}
},
{
"name":{
"value":"PractitionerRole"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/practitioner-role"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Demographics and qualification information for an individual who is directly or indirectly involved in the provisioning of healthcare.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner\"><b>Practitioner<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"An identifier that applies to this person in this role.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">A identifier for the person as this agent<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the practitioner, e.g. a telephone number or an email address.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"One or more addresses where the practitioner can be found or visited.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">One or more addresses for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"The date and time of birth for the practitioner.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.birthDate\"><b>birthDate<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">The date and time of birth for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n <<a title=\"The organization that the practitioner represents.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.organization\"><b>organization<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">The represented organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></organization>\r\n <<a title=\"The way in which the person represents the organization - what role do they have?.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-role.htm\">A role the practitioner has<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"Specific specialty of the practitioner.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.specialty\"><b>specialty<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-specialty.htm\">Specific specialty of the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></specialty>\r\n <<a title=\"The period during which the person is authorized to perform the service.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The period during which the person is authorized to perform the service<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Qualifications relevant to the provided service.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification\"><b>qualification<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Qualifications relevant to the provided service --><\/span>\r\n <<a title=\"Coded representation of the qualification.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-anzsco-occupations.htm\">Qualification<\/a><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"Period during which the qualification is valid.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Period during which the qualification is valid<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"Organization that regulates and issues the qualification.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.qualification.issuer\"><b>issuer<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"organization.htm#Organization\">Organization<\/a>)<\/span> <span style=\"color: navy\">Organization that regulates and issues the qualification<\/span><span style=\"color: Gray\"> --><\/span></issuer>\r\n </qualification>\r\n <<a title=\"A language the practitioner is able to use in patient communication.\" class=\"dict\" href=\"practitioner-definitions.htm#Practitioner.communication\"><b>communication<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.htm\">A language the practitioner is able to use in patient communication<\/a><\/span><span style=\"color: Gray\"> --><\/span></communication>\r\n</Practitioner>\r\n<\/pre><\/div>"
},
{
"title":"\"procedure\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/procedure",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/procedure.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure\"><b>Procedure<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The person on whom the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The specific procedure that is performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Identification of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Precise location details<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.indication\"><b>indication<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Indications for the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Limited to 'real' people rather than equipment.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer\"><b>performer<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The people who performed the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"The practitioner who was involved in the procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer.person\"><b>person<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The reference to the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></person>\r\n <<a title=\"E.g. surgeon, anaethetist, endoscopist.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The role the person was in<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n </performer>\r\n <<a title=\"The dates over which the period was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.date\"><b>date<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The date the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></date>\r\n <<a title=\"The encounter during which the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">The encounter during which the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Outcome of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.report\"><b>report<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"diagnosticreport.htm#DiagnosticReport\">DiagnosticReport<\/a>)<\/span> <span style=\"color: navy\">Any report that results from the procedure<\/span><span style=\"color: Gray\"> --><\/span></report>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.complication\"><b>complication<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Complications<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.followUp\"><b>followUp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Instructions for follow up<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem\"><b>relatedItem<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A procedure that is related to this one --><\/span>\r\n <<a title=\"The nature of the relationship.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"procedure-relationship-type.htm\">caused-by | caused<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The related item - e.g. a procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"procedure.htm#Procedure\">Procedure<\/a>|<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">The related item - e.g. a procedure<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </relatedItem>\r\n <<a title=\"Any other notes about the procedure - e.g. the operative notes.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Procedure notes<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Procedure>\r\n<\/pre><\/div>"
},
"name":{
"value":"procedure"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Procedure"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Procedure"
},
"definition":{
"short":{
"value":"An action that is performed on a patient"
},
"formal":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.subject"
},
"definition":{
"short":{
"value":"Subject of this procedure"
},
"formal":{
"value":"The person on whom the procedure was performed."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.type"
},
"definition":{
"short":{
"value":"Identification of the procedure"
},
"formal":{
"value":"The specific procedure that is performed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.bodySite"
},
"definition":{
"short":{
"value":"Precise location details"
},
"formal":{
"value":"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.indication"
},
"definition":{
"short":{
"value":"Indications for the procedure"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.performer"
},
"definition":{
"short":{
"value":"The people who performed the procedure"
},
"formal":{
"value":"Limited to 'real' people rather than equipment."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.performer.person"
},
"definition":{
"short":{
"value":"The reference to the practitioner"
},
"formal":{
"value":"The practitioner who was involved in the procedure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.performer.role"
},
"definition":{
"short":{
"value":"The role the person was in"
},
"formal":{
"value":"E.g. surgeon, anaethetist, endoscopist."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.date"
},
"definition":{
"short":{
"value":"The date the procedure was performed"
},
"formal":{
"value":"The dates over which the period was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.encounter"
},
"definition":{
"short":{
"value":"The encounter during which the procedure was performed"
},
"formal":{
"value":"The encounter during which the procedure was performed."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.outcome"
},
"definition":{
"short":{
"value":"Outcome of the procedure"
},
"formal":{
"value":"What was the outcome of the procedure - did it resolve reasons why the procedure was performed?."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.report"
},
"definition":{
"short":{
"value":"Any report that results from the procedure"
},
"formal":{
"value":"This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(DiagnosticReport)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.complication"
},
"definition":{
"short":{
"value":"Complications"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.followUp"
},
"definition":{
"short":{
"value":"Instructions for follow up"
},
"formal":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.relatedItem"
},
"definition":{
"short":{
"value":"A procedure that is related to this one"
},
"formal":{
"value":"Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.relatedItem.type"
},
"definition":{
"short":{
"value":"caused-by | caused"
},
"formal":{
"value":"The nature of the relationship."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ProcedureRelationshipType"
}
}
},
{
"path":{
"value":"Procedure.relatedItem.target"
},
"definition":{
"short":{
"value":"The related item - e.g. a procedure"
},
"formal":{
"value":"The related item - e.g. a procedure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Procedure|MedicationPrescription)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Procedure.notes"
},
"definition":{
"short":{
"value":"Procedure notes"
},
"formal":{
"value":"Any other notes about the procedure - e.g. the operative notes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"ProcedureRelationshipType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/procedure-relationship-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure\"><b>Procedure<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The person on whom the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Subject of this procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The specific procedure that is performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Identification of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.bodySite\"><b>bodySite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Precise location details<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></bodySite>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.indication\"><b>indication<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Indications for the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Limited to 'real' people rather than equipment.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer\"><b>performer<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> The people who performed the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span> --><\/span>\r\n <<a title=\"The practitioner who was involved in the procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer.person\"><b>person<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">The reference to the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></person>\r\n <<a title=\"E.g. surgeon, anaethetist, endoscopist.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.performer.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">The role the person was in<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n </performer>\r\n <<a title=\"The dates over which the period was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.date\"><b>date<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">The date the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></date>\r\n <<a title=\"The encounter during which the procedure was performed.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">The encounter during which the procedure was performed<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Outcome of the procedure<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.report\"><b>report<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"diagnosticreport.htm#DiagnosticReport\">DiagnosticReport<\/a>)<\/span> <span style=\"color: navy\">Any report that results from the procedure<\/span><span style=\"color: Gray\"> --><\/span></report>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.complication\"><b>complication<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Complications<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.followUp\"><b>followUp<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Instructions for follow up<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem\"><b>relatedItem<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> A procedure that is related to this one --><\/span>\r\n <<a title=\"The nature of the relationship.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"procedure-relationship-type.htm\">caused-by | caused<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The related item - e.g. a procedure.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.relatedItem.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"procedure.htm#Procedure\">Procedure<\/a>|<a href=\"medicationprescription.htm#MedicationPrescription\">MedicationPrescription<\/a>)<\/span> <span style=\"color: navy\">The related item - e.g. a procedure<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </relatedItem>\r\n <<a title=\"Any other notes about the procedure - e.g. the operative notes.\" class=\"dict\" href=\"procedure-definitions.htm#Procedure.notes\"><b>notes<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Procedure notes<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Procedure>\r\n<\/pre><\/div>"
},
{
"title":"\"profile\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/profile",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/profile.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.\" class=\"dict\" href=\"profile-definitions.htm#Profile\"><b>Profile<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"profile-definitions.htm#Profile.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"profile-definitions.htm#Profile.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name identifying the Profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Informal name for this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the individual or organization who accepts responsibility for publishing the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contact details to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"profile-definitions.htm#Profile.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the profile and its use.\" class=\"dict\" href=\"profile-definitions.htm#Profile.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Natural language description of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A set of terms from external terminologies that may be used to assist with indexing and searching of templates.\" class=\"dict\" href=\"profile-definitions.htm#Profile.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Assist with indexing and finding<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The status of the profile (this element modifies the meaning of other elements)\" class=\"dict\" href=\"profile-definitions.htm#Profile.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-profile-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"profile-definitions.htm#Profile.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date that this version of the profile was published.\" class=\"dict\" href=\"profile-definitions.htm#Profile.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the FHIR specification on which this profile is based.\" class=\"dict\" href=\"profile-definitions.htm#Profile.fhirVersion\"><b>fhirVersion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">FHIR Version this profile targets<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A constraint statement about what contents a resource or data type may have.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure\"><b>structure<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..*<\/b><\/span> A constraint on a resource or a data type --><\/span>\r\n <<a title=\"The Resource or Data type being described.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"defined-types.htm\">The Resource or Data Type being described<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile).\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name for this particular structure (reference target)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.publish\"><b>publish<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">This definition is published (i.e. for validation)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human summary: why describe this resource?.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.purpose\"><b>purpose<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human summary: why describe this resource?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Captures constraints on each element within the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element\"><b>element<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: Provide either a profile reference or constraints on the resource elements (but not both)\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Definition of elements in the resource (if no profile) --><\/span>\r\n <<a title=\"The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.path\"><b>path<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The path of the element (see the formal definitions)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name for this particular element definition (reference target)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing\"><b>slicing<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> This element is sliced - slices follow --><\/span>\r\n <<a title=\"Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance must completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.discriminator\"><b>discriminator<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Element that used to distinguish the slices<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If the matching elements have to occur in the same order as defined in the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.ordered\"><b>ordered<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If elements must be in same order as slices<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.rules\"><b>rules<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-slicing-rules.htm\">Whether slice list is open or closed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </slicing>\r\n <<a title=\"Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition\"><b>definition<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> More specific definition of the element --><\/span>\r\n <<a title=\"A concise definition that is shown in the concise XML format that summarizes profiles.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.short\"><b>short<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Concise definition for xml presentation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The definition must be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.formal\"><b>formal<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.comments\"><b>comments<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the use of this element<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Explains why this element is needed and why it's been constrained as it has.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.requirements\"><b>requirements<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Why is this needed?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies additional names by which this element might also be known.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.synonym\"><b>synonym<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Other names<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The minimum number of times this element must appear in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.min\"><b>min<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Minimum Cardinality<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The maximum number of times this element is permitted to appear in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.max\"><b>max<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Max must be a number or "*"\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Maximum Cardinality (a number or *)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The data type or resource that the value of this element is permitted to be.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type\"><b>type<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Type of the element --><\/span>\r\n <<a title=\"Data type or Resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"data-types.htm\">Data type or Resource<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies a profile that must hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.profile\"><b>profile<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Profile.structure to apply<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether the Resource that is the value for this element is included in the bundle, if the profile is specifying a bundle.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.bundled\"><b>bundled<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-9: Bundled may only be specified if one of the allowed types for the element is a resource\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If code is a Resource, is it in the bundle?<\/span><span style=\"color: Gray\"> --><\/span>\r\n </type>\r\n <<a title=\"Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.nameReference\"><b>nameReference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">To another element constraint (by element.name)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies a value that must hold for this element in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted; Inv-10: Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types.\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Fixed value: [as defined for type]<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"An example value for this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.example_x_\"><b>example[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Example value: [as defined for type]<\/span><span style=\"color: Gray\"> --><\/span></example[x]>\r\n <<a title=\"Indicates the shortest length that must be supported by conformant instances without truncation.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.maxLength\"><b>maxLength<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Length for strings<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A reference to an invariant that may make additional statements about the cardinality in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.condition\"><b>condition<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Reference to invariant about presence<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint\"><b>constraint<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Condition that must evaluate to true --><\/span>\r\n <<a title=\"Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Target of 'condition' reference above<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Used to label the constraint in OCL or in short displays incapable of displaying the full human description.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Short human label<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the impact constraint violation has on the conformance of the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.severity\"><b>severity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"constraint-severity.htm\">error | warning<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Text that can be used to describe the constraint in messages identifying that the constraint has been violated.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.human\"><b>human<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Human description of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"XPath expression of constraint.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.xpath\"><b>xpath<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">XPath expression of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"OCL expression of constraint.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.ocl\"><b>ocl<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">OCL expression of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n </constraint>\r\n <<a title=\"If true, conformant resource authors must be capable of providing a value for the element and resource consumers must be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mustSupport\"><b>mustSupport<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If the element must be usable<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they must either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.isModifier\"><b>isModifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If this modifies the meaning of other elements<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the set of codes that applies to this element if a data type supporting codes is used. The reference can be local - to a Profile.binding.name, or absolute, to a binding.name in another profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.binding\"><b>binding<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-7: Binding can only be present for coded elements\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reference to a binding (local or absolute)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies a concept from an external specification that roughly corresponds to this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping\"><b>mapping<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Map element to another set of definitions --><\/span>\r\n <<a title=\"The name of the specification is mapping is being expressed to.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping.target\"><b>target<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Which mapping this is (v2, CDA, openEHR, etc.)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Expresses what part of the target specification corresponds to this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping.map\"><b>map<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Details of the mapping<\/span><span style=\"color: Gray\"> --><\/span>\r\n </mapping>\r\n </definition>\r\n </element>\r\n </structure>\r\n <<a title=\"An extension defined as part of the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn\"><b>extensionDefn<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Definition of an extension --><\/span>\r\n <<a title=\"A unique code (within the profile) used to identify the extension.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-5: Codes must be unique in the context of a profile\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identifies the extension in this profile<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the type of context to which the extension applies.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.contextType\"><b>contextType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"extension-context.htm\">resource | datatype | mapping | extension<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the types of resource or data type elements to which the extension can be applied.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.context\"><b>context<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\">Where the extension can be used in instances<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Definition of the extension and its content.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.definition\"><b>definition<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for Profile.structure.element.definition<\/span> <span style=\"color: navy\">Definition of the extension and its content<\/span><span style=\"color: Gray\"> --><\/span></definition>\r\n </extensionDefn>\r\n <<a title=\"Defines a linkage between a vocabulary binding name used in the profile (or expected to be used in profile importing this one) and a value set or code list.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding\"><b>binding<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Define code sets for coded elements --><\/span>\r\n <<a title=\"The name to be associated with this set of codes.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-11: Binding name must be unique in the context of a profile\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Binding name<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.isExtensible\"><b>isExtensible<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Can additional codes be used?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the degree of conformance expectations associated with this binding.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.conformance\"><b>conformance<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"binding-conformance.htm\">required | preferred | example<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the intended use of this particular set of codes.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: provide either a reference or a description\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human explanation of the binding<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Points to the value set or external definition that identifies the set of codes to be used.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.reference_x_\"><b>reference[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: provide either a reference or a description\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a>|<a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"valueset.htm#ValueSet\">ValueSet<\/a>)<\/span> <span style=\"color: navy\">Source of binding content<\/span><span style=\"color: Gray\"> --><\/span></reference[x]>\r\n </binding>\r\n</Profile>\r\n<\/pre><\/div>"
},
"name":{
"value":"profile"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Profile"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Profile"
},
"definition":{
"short":{
"value":"Resource Profile"
},
"formal":{
"value":"A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."
},
"comments":{
"value":"Often called a clinical template."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"8"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must define at least one resource constraint, extension definition or binding"
},
"xpath":{
"value":"exists(f:structure) or exists(f:extensionDefn) or exists(f:binding)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.identifier"
},
"definition":{
"short":{
"value":"Logical id to reference this profile"
},
"formal":{
"value":"The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)."
},
"comments":{
"value":"N/A."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.version"
},
"definition":{
"short":{
"value":"Logical id for this version of the profile"
},
"formal":{
"value":"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."
},
"comments":{
"value":"N/A."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.name"
},
"definition":{
"short":{
"value":"Informal name for this profile"
},
"formal":{
"value":"A free text natural language name identifying the Profile."
},
"comments":{
"value":"Not expected to be globally unique."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.publisher"
},
"definition":{
"short":{
"value":"Name of the publisher (Organization or individual)"
},
"formal":{
"value":"Details of the individual or organization who accepts responsibility for publishing the profile."
},
"comments":{
"value":"Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.telecom"
},
"definition":{
"short":{
"value":"Contact information of the publisher"
},
"formal":{
"value":"Contact details to assist a user in finding and communicating with the publisher."
},
"comments":{
"value":"May be a web site, an email address, a telephone number (tel:), etc."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.description"
},
"definition":{
"short":{
"value":"Natural language description of the profile"
},
"formal":{
"value":"A free text natural language description of the profile and its use."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.code"
},
"definition":{
"short":{
"value":"Assist with indexing and finding"
},
"formal":{
"value":"A set of terms from external terminologies that may be used to assist with indexing and searching of templates."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.status"
},
"definition":{
"short":{
"value":"draft | experimental | review | production | withdrawn | superseded"
},
"formal":{
"value":"The status of the profile."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ResourceProfileStatus"
}
}
},
{
"path":{
"value":"Profile.experimental"
},
"definition":{
"short":{
"value":"If for testing purposes, not real usage"
},
"formal":{
"value":"This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.date"
},
"definition":{
"short":{
"value":"Date for this version of the profile"
},
"formal":{
"value":"The date that this version of the profile was published."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.fhirVersion"
},
"definition":{
"short":{
"value":"FHIR Version this profile targets"
},
"formal":{
"value":"The version of the FHIR specification on which this profile is based."
},
"comments":{
"value":"A profile does not need to specify the target it applies to,as profiles will often be valid across multiple versions of FHIR. FHIR tooling can determine whether a profile is consistent with a particular profile if desired."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure"
},
"definition":{
"short":{
"value":"A constraint on a resource or a data type"
},
"formal":{
"value":"A constraint statement about what contents a resource or data type may have."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"severity":{
"value":"error"
},
"human":{
"value":"Provide either a profile reference or constraints on the resource elements (but not both)"
},
"xpath":{
"value":"exists(f:profile) != exists(f:element)"
}
},
{
"key":{
"value":"12"
},
"severity":{
"value":"error"
},
"human":{
"value":"Only complex types can be constrained, not primitive types such as string etc."
},
"xpath":{
"value":"upper-case(substring(f:type,1,1))=substring(f:type,1,1)"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.type"
},
"definition":{
"short":{
"value":"The Resource or Data Type being described"
},
"formal":{
"value":"The Resource or Data type being described."
},
"comments":{
"value":"Only complex types can be constrained, not primitive types such as string etc."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"FHIRDefinedType"
}
}
},
{
"path":{
"value":"Profile.structure.name"
},
"definition":{
"short":{
"value":"Name for this particular structure (reference target)"
},
"formal":{
"value":"The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile)."
},
"comments":{
"value":"This field is the target for a resource.profile."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.publish"
},
"definition":{
"short":{
"value":"This definition is published (i.e. for validation)"
},
"formal":{
"value":"This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context."
},
"comments":{
"value":"If there is more than one published structure for each type, and the URL reference to the profile doesn't specify which named structure to use (using a URL fragment, e.g. #...) then which profile to use is indeterminate, and an error should be raised."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.purpose"
},
"definition":{
"short":{
"value":"Human summary: why describe this resource?"
},
"formal":{
"value":"Human summary: why describe this resource?."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element"
},
"definition":{
"short":{
"value":"Definition of elements in the resource (if no profile)"
},
"formal":{
"value":"Captures constraints on each element within the resource."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.path"
},
"definition":{
"short":{
"value":"The path of the element (see the formal definitions)"
},
"formal":{
"value":"The path identifies the element and is expressed as a \".\"-separated list of ancestor elements, beginning with the name of the resource."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.name"
},
"definition":{
"short":{
"value":"Name for this particular element definition (reference target)"
},
"formal":{
"value":"The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element."
},
"comments":{
"value":"The name must be unique within the profile and all imported profiles within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.slicing"
},
"definition":{
"short":{
"value":"This element is sliced - slices follow"
},
"formal":{
"value":"Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set)."
},
"comments":{
"value":"The definition associated with this element definition is the master for all the slices."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.slicing.discriminator"
},
"definition":{
"short":{
"value":"Element that used to distinguish the slices"
},
"formal":{
"value":"Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance must completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.slicing.ordered"
},
"definition":{
"short":{
"value":"If elements must be in same order as slices"
},
"formal":{
"value":"If the matching elements have to occur in the same order as defined in the profile."
},
"comments":{
"value":"Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.slicing.rules"
},
"definition":{
"short":{
"value":"Whether slice list is open or closed"
},
"formal":{
"value":"Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end."
},
"comments":{
"value":"Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SlicingRules"
}
}
},
{
"path":{
"value":"Profile.structure.element.definition"
},
"definition":{
"short":{
"value":"More specific definition of the element"
},
"formal":{
"value":"Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource."
},
"comments":{
"value":"The definition must be a proper constraint on the definition of the base resource."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"severity":{
"value":"error"
},
"human":{
"value":"Either a namereference or a fixed value (but not both) is permitted"
},
"xpath":{
"value":"not(exists(f:nameReference) and exists(f:*[starts-with(local-name(.), 'value')]))"
}
},
{
"key":{
"value":"10"
},
"severity":{
"value":"error"
},
"human":{
"value":"Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types."
},
"xpath":{
"value":"not(exists(f:*[starts-with(local-name(.), 'value')])) or (count(f:type)=1 and f:type/f:code[substring(@value,1,1)=lower-case(substring(@value,1,1))])"
}
},
{
"key":{
"value":"7"
},
"severity":{
"value":"error"
},
"human":{
"value":"Binding can only be present for coded elements"
},
"xpath":{
"value":"not(exists(f:binding)) or f:type/f:code/@value=('code','Coding','CodeableConcept','Quantity')"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.short"
},
"definition":{
"short":{
"value":"Concise definition for xml presentation"
},
"formal":{
"value":"A concise definition that is shown in the concise XML format that summarizes profiles."
},
"comments":{
"value":"May change the term to provide language more appropriate to the context of the profile or to reflect slicing."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.formal"
},
"definition":{
"short":{
"value":"Formal definition"
},
"formal":{
"value":"The definition must be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource."
},
"comments":{
"value":"It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.comments"
},
"definition":{
"short":{
"value":"Comments about the use of this element"
},
"formal":{
"value":"Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc."
},
"comments":{
"value":"If it is possible to capture usage rules using invariants, that mechanism should be used in preference to this element."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.requirements"
},
"definition":{
"short":{
"value":"Why is this needed?"
},
"formal":{
"value":"Explains why this element is needed and why it's been constrained as it has."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.synonym"
},
"definition":{
"short":{
"value":"Other names"
},
"formal":{
"value":"Identifies additional names by which this element might also be known."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.min"
},
"definition":{
"short":{
"value":"Minimum Cardinality"
},
"formal":{
"value":"The minimum number of times this element must appear in the instance."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.max"
},
"definition":{
"short":{
"value":"Maximum Cardinality (a number or *)"
},
"formal":{
"value":"The maximum number of times this element is permitted to appear in the instance."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"6"
},
"severity":{
"value":"error"
},
"human":{
"value":"Max must be a number or \"*\""
},
"xpath":{
"value":"@value='*' or (normalize-space(@value)!='' and normalize-space(translate(@value, '0123456789',''))='')"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.type"
},
"definition":{
"short":{
"value":"Type of the element"
},
"formal":{
"value":"The data type or resource that the value of this element is permitted to be."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"9"
},
"severity":{
"value":"error"
},
"human":{
"value":"Bundled may only be specified if one of the allowed types for the element is a resource"
},
"xpath":{
"value":"not(exists(f:bundled)) or exists(f:code[starts-with(@value, 'Resource(')])"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.type.code"
},
"definition":{
"short":{
"value":"Data type or Resource"
},
"formal":{
"value":"Data type or Resource."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DataType"
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.type.profile"
},
"definition":{
"short":{
"value":"Profile.structure to apply"
},
"formal":{
"value":"Identifies a profile that must hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile."
},
"comments":{
"value":"The reference might be a simple name in the form #[name], which is a reference to another named constraint in a resource - where the resource contains more than one constraint, or a URL which is a reference to a resource Profile."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.type.bundled"
},
"definition":{
"short":{
"value":"If code is a Resource, is it in the bundle?"
},
"formal":{
"value":"Whether the Resource that is the value for this element is included in the bundle, if the profile is specifying a bundle."
},
"comments":{
"value":"If context includes bundling."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.nameReference"
},
"definition":{
"short":{
"value":"To another element constraint (by element.name)"
},
"formal":{
"value":"Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element."
},
"comments":{
"value":"If child components of this element are defined, they act as constraints on the referenced slice."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.value[x]"
},
"definition":{
"short":{
"value":"Fixed value: [as defined for type]"
},
"formal":{
"value":"Specifies a value that must hold for this element in the instance."
},
"comments":{
"value":"To specify a fixed value for a complex data type, include the child elements for the type and specify fixed values for each property independently."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"*"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.example[x]"
},
"definition":{
"short":{
"value":"Example value: [as defined for type]"
},
"formal":{
"value":"An example value for this element."
},
"comments":{
"value":"If the example value are fully populated, the publication tool can generate an instance automatically."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"*"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.maxLength"
},
"definition":{
"short":{
"value":"Length for strings"
},
"formal":{
"value":"Indicates the shortest length that must be supported by conformant instances without truncation."
},
"comments":{
"value":"If not specified, there is no conformance expectation for length support."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.condition"
},
"definition":{
"short":{
"value":"Reference to invariant about presence"
},
"formal":{
"value":"A reference to an invariant that may make additional statements about the cardinality in the instance."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint"
},
"definition":{
"short":{
"value":"Condition that must evaluate to true"
},
"formal":{
"value":"Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance."
},
"comments":{
"value":"Constraints should be declared on the \"context\" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.key"
},
"definition":{
"short":{
"value":"Target of 'condition' reference above"
},
"formal":{
"value":"Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"id"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.name"
},
"definition":{
"short":{
"value":"Short human label"
},
"formal":{
"value":"Used to label the constraint in OCL or in short displays incapable of displaying the full human description."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.severity"
},
"definition":{
"short":{
"value":"error | warning"
},
"formal":{
"value":"Identifies the impact constraint violation has on the conformance of the instance."
},
"comments":{
"value":"This allows constraints to be asserted as \"shall\" (error) and \"should\" (warning)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ConstraintSeverity"
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.human"
},
"definition":{
"short":{
"value":"Human description of constraint"
},
"formal":{
"value":"Text that can be used to describe the constraint in messages identifying that the constraint has been violated."
},
"comments":{
"value":"Should be expressed in business terms as much as possible."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.xpath"
},
"definition":{
"short":{
"value":"XPath expression of constraint"
},
"formal":{
"value":"XPath expression of constraint."
},
"comments":{
"value":"Elements must use \"f\" as the namespace prefix and must not use any other prefixes."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.constraint.ocl"
},
"definition":{
"short":{
"value":"OCL expression of constraint"
},
"formal":{
"value":"OCL expression of constraint."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.mustSupport"
},
"definition":{
"short":{
"value":"If the element must be usable"
},
"formal":{
"value":"If true, conformant resource authors must be capable of providing a value for the element and resource consumers must be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported."
},
"comments":{
"value":"\"Something useful\" is context dependent. This flag is never set to true by the FHIR specification itself - it is only set to true in profiles, and when the profile sets it true, it must describe what it means for applications to support the element. In general, the question is what would a reasonable observer expect of a system that explicitly claims to \"support\" this element?."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.isModifier"
},
"definition":{
"short":{
"value":"If this modifies the meaning of other elements"
},
"formal":{
"value":"If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they must either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system."
},
"comments":{
"value":"Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set to false, it cannot be set to true in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.binding"
},
"definition":{
"short":{
"value":"Reference to a binding (local or absolute)"
},
"formal":{
"value":"Identifies the set of codes that applies to this element if a data type supporting codes is used. The reference can be local - to a Profile.binding.name, or absolute, to a binding.name in another profile."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.mapping"
},
"definition":{
"short":{
"value":"Map element to another set of definitions"
},
"formal":{
"value":"Identifies a concept from an external specification that roughly corresponds to this element."
},
"comments":{
"value":"Mappings are not necessarily specific enough for safe translation."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.mapping.target"
},
"definition":{
"short":{
"value":"Which mapping this is (v2, CDA, openEHR, etc.)"
},
"formal":{
"value":"The name of the specification is mapping is being expressed to."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.structure.element.definition.mapping.map"
},
"definition":{
"short":{
"value":"Details of the mapping"
},
"formal":{
"value":"Expresses what part of the target specification corresponds to this element."
},
"comments":{
"value":"For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.extensionDefn"
},
"definition":{
"short":{
"value":"Definition of an extension"
},
"formal":{
"value":"An extension defined as part of the profile."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.extensionDefn.code"
},
"definition":{
"short":{
"value":"Identifies the extension in this profile"
},
"formal":{
"value":"A unique code (within the profile) used to identify the extension."
},
"comments":{
"value":"Matches the portion of a reference to an extension after the # in the a url to the profile."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"5"
},
"severity":{
"value":"error"
},
"human":{
"value":"Codes must be unique in the context of a profile"
},
"xpath":{
"value":"count(ancestor::f:Profile/f:extensionDefn/f:code[@value=current()/@value])=1"
}
}
],
"isModifier":{
"value":false
},
"binding":{
"value":"!"
}
}
},
{
"path":{
"value":"Profile.extensionDefn.contextType"
},
"definition":{
"short":{
"value":"resource | datatype | mapping | extension"
},
"formal":{
"value":"Identifies the type of context to which the extension applies."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ExtensionContext"
}
}
},
{
"path":{
"value":"Profile.extensionDefn.context"
},
"definition":{
"short":{
"value":"Where the extension can be used in instances"
},
"formal":{
"value":"Identifies the types of resource or data type elements to which the extension can be applied."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.extensionDefn.definition"
},
"definition":{
"short":{
"value":"Definition of the extension and its content"
},
"formal":{
"value":"Definition of the extension and its content."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"@Profile.structure.element.definition"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.binding"
},
"definition":{
"short":{
"value":"Define code sets for coded elements"
},
"formal":{
"value":"Defines a linkage between a vocabulary binding name used in the profile (or expected to be used in profile importing this one) and a value set or code list."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"severity":{
"value":"error"
},
"human":{
"value":"provide either a reference or a description"
},
"xpath":{
"value":"(exists(f:referenceUri) or exists(f:referenceResource)) or exists(f:description) or exists(f:name)"
}
},
{
"key":{
"value":"14"
},
"severity":{
"value":"error"
},
"human":{
"value":"Example value sets are always extensible"
},
"xpath":{
"value":"not(f:conformance/@value='example' and f:isExtensible.value='false')"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.binding.name"
},
"definition":{
"short":{
"value":"Binding name"
},
"formal":{
"value":"The name to be associated with this set of codes."
},
"comments":{
"value":"Must be unique within the profile. If the same name as an imported profile, will override the imported binding (and must be a proper constraint on the imported binding)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"11"
},
"severity":{
"value":"error"
},
"human":{
"value":"Binding name must be unique in the context of a profile"
},
"xpath":{
"value":"count(ancestor::f:Profile/f:binding/f:name[@value=current()/@value])=1"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.binding.isExtensible"
},
"definition":{
"short":{
"value":"Can additional codes be used?"
},
"formal":{
"value":"If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone."
},
"comments":{
"value":"When the binding use used for elements with a type of \"code\" (rather than Coding or CodableConcept), the binding is treated as non-extensible regardless of the value of this property."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.binding.conformance"
},
"definition":{
"short":{
"value":"required | preferred | example"
},
"formal":{
"value":"Indicates the degree of conformance expectations associated with this binding."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BindingConformance"
}
}
},
{
"path":{
"value":"Profile.binding.description"
},
"definition":{
"short":{
"value":"Human explanation of the binding"
},
"formal":{
"value":"Describes the intended use of this particular set of codes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Profile.binding.reference[x]"
},
"definition":{
"short":{
"value":"Source of binding content"
},
"formal":{
"value":"Points to the value set or external definition that identifies the set of codes to be used."
},
"comments":{
"value":"For value sets,the referenceResource, the display can contain the value set description. The reference may be version-specific or not."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
},
{
"code":{
"value":"Resource(ValueSet)"
}
}
],
"condition":[
],
"constraint":[
{
"key":{
"value":"13"
},
"severity":{
"value":"error"
},
"human":{
"value":"uri must start with http:// or https://"
},
"xpath":{
"value":"starts-with(@value, 'http:') or starts-with(@value, 'https:')"
}
}
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"BindingConformance"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/binding-conformance"
}
}
},
{
"name":{
"value":"ConstraintSeverity"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/constraint-severity"
}
}
},
{
"name":{
"value":"DataType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/data-types"
}
}
},
{
"name":{
"value":"ResourceProfileStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/resource-profile-status"
}
}
},
{
"name":{
"value":"ExtensionContext"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/extension-context"
}
}
},
{
"name":{
"value":"FHIRDefinedType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/defined-types"
}
}
},
{
"name":{
"value":"SlicingRules"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/resource-slicing-rules"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions.\" class=\"dict\" href=\"profile-definitions.htm#Profile\"><b>Profile<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The identifier that is used to identify this profile when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"profile-definitions.htm#Profile.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id to reference this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"profile-definitions.htm#Profile.version\"><b>version<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical id for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text natural language name identifying the Profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Informal name for this profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details of the individual or organization who accepts responsibility for publishing the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.publisher\"><b>publisher<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Contact details to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"profile-definitions.htm#Profile.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"A free text natural language description of the profile and its use.\" class=\"dict\" href=\"profile-definitions.htm#Profile.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Natural language description of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A set of terms from external terminologies that may be used to assist with indexing and searching of templates.\" class=\"dict\" href=\"profile-definitions.htm#Profile.code\"><b>code<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Assist with indexing and finding<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></code>\r\n <<a title=\"The status of the profile (this element modifies the meaning of other elements)\" class=\"dict\" href=\"profile-definitions.htm#Profile.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-profile-status.htm\">draft | experimental | review | production | withdrawn | superseded<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"profile-definitions.htm#Profile.experimental\"><b>experimental<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date that this version of the profile was published.\" class=\"dict\" href=\"profile-definitions.htm#Profile.date\"><b>date<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Date for this version of the profile<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The version of the FHIR specification on which this profile is based.\" class=\"dict\" href=\"profile-definitions.htm#Profile.fhirVersion\"><b>fhirVersion<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">FHIR Version this profile targets<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A constraint statement about what contents a resource or data type may have.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure\"><b>structure<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..*<\/b><\/span> A constraint on a resource or a data type --><\/span>\r\n <<a title=\"The Resource or Data type being described.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"defined-types.htm\">The Resource or Data Type being described<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of this resource constraint statement (to refer to it from other resource constraints - from Profile.structure.element.definition.type.profile).\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name for this particular structure (reference target)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"This definition of a profile on a structure is published as a formal statement. Some structural definitions might be defined purely for internal use within the profile, and not intended to be used outside that context.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.publish\"><b>publish<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">This definition is published (i.e. for validation)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human summary: why describe this resource?.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.purpose\"><b>purpose<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human summary: why describe this resource?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Captures constraints on each element within the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element\"><b>element<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: Provide either a profile reference or constraints on the resource elements (but not both)\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Definition of elements in the resource (if no profile) --><\/span>\r\n <<a title=\"The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.path\"><b>path<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The path of the element (see the formal definitions)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The name of this element definition (to refer to it from other element definitions using Profile.structure.element.definition.nameReference). This is a unique name referring to a specific set of constraints applied to this element. One use of this is to provide a name to different slices of the same element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Name for this particular element definition (reference target)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates that the element is sliced into a set of alternative definitions (there are multiple definitions on a single element in the base resource). The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing\"><b>slicing<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> This element is sliced - slices follow --><\/span>\r\n <<a title=\"Designates which child element is used to discriminate between the slices when processing an instance. The value of the child element in the instance must completely distinguish which slice the element in the resource matches based on the allowed values for that element in each of the slices.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.discriminator\"><b>discriminator<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Element that used to distinguish the slices<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If the matching elements have to occur in the same order as defined in the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.ordered\"><b>ordered<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If elements must be in same order as slices<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.slicing.rules\"><b>rules<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"resource-slicing-rules.htm\">Whether slice list is open or closed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </slicing>\r\n <<a title=\"Definition of the content of the element to provide a more specific definition than that contained for the element in the base resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition\"><b>definition<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> More specific definition of the element --><\/span>\r\n <<a title=\"A concise definition that is shown in the concise XML format that summarizes profiles.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.short\"><b>short<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Concise definition for xml presentation<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The definition must be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.formal\"><b>formal<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Formal definition<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.comments\"><b>comments<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Comments about the use of this element<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Explains why this element is needed and why it's been constrained as it has.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.requirements\"><b>requirements<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Why is this needed?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies additional names by which this element might also be known.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.synonym\"><b>synonym<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Other names<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The minimum number of times this element must appear in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.min\"><b>min<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Minimum Cardinality<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The maximum number of times this element is permitted to appear in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.max\"><b>max<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-6: Max must be a number or "*"\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Maximum Cardinality (a number or *)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The data type or resource that the value of this element is permitted to be.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type\"><b>type<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Type of the element --><\/span>\r\n <<a title=\"Data type or Resource.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"data-types.htm\">Data type or Resource<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies a profile that must hold for resources or datatypes referenced as the type of this element. Can be a local reference - to another structure in this profile, or a reference to a structure in another profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.profile\"><b>profile<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Profile.structure to apply<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Whether the Resource that is the value for this element is included in the bundle, if the profile is specifying a bundle.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.type.bundled\"><b>bundled<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-9: Bundled may only be specified if one of the allowed types for the element is a resource\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If code is a Resource, is it in the bundle?<\/span><span style=\"color: Gray\"> --><\/span>\r\n </type>\r\n <<a title=\"Identifies the name of a slice defined elsewhere in the profile whose constraints should be applied to the current element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.nameReference\"><b>nameReference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">To another element constraint (by element.name)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Specifies a value that must hold for this element in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.value_x_\"><b>value[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either a namereference or a fixed value (but not both) is permitted; Inv-10: Value may only be specified if the type consists of a single repetition that has a type corresponding to one of the primitive data types.\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Fixed value: [as defined for type]<\/span><span style=\"color: Gray\"> --><\/span></value[x]>\r\n <<a title=\"An example value for this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.example_x_\"><b>example[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Example value: [as defined for type]<\/span><span style=\"color: Gray\"> --><\/span></example[x]>\r\n <<a title=\"Indicates the shortest length that must be supported by conformant instances without truncation.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.maxLength\"><b>maxLength<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Length for strings<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A reference to an invariant that may make additional statements about the cardinality in the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.condition\"><b>condition<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Reference to invariant about presence<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint\"><b>constraint<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Condition that must evaluate to true --><\/span>\r\n <<a title=\"Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.key\"><b>key<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#id\">id<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Target of 'condition' reference above<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Used to label the constraint in OCL or in short displays incapable of displaying the full human description.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Short human label<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the impact constraint violation has on the conformance of the instance.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.severity\"><b>severity<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"constraint-severity.htm\">error | warning<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Text that can be used to describe the constraint in messages identifying that the constraint has been violated.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.human\"><b>human<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Human description of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"XPath expression of constraint.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.xpath\"><b>xpath<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">XPath expression of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"OCL expression of constraint.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.constraint.ocl\"><b>ocl<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">OCL expression of constraint<\/span><span style=\"color: Gray\"> --><\/span>\r\n </constraint>\r\n <<a title=\"If true, conformant resource authors must be capable of providing a value for the element and resource consumers must be capable of extracting and doing something useful with the data element. If false, the element may be ignored and not supported.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mustSupport\"><b>mustSupport<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">If the element must be usable<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they must either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.isModifier\"><b>isModifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">If this modifies the meaning of other elements<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the set of codes that applies to this element if a data type supporting codes is used. The reference can be local - to a Profile.binding.name, or absolute, to a binding.name in another profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.binding\"><b>binding<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-7: Binding can only be present for coded elements\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Reference to a binding (local or absolute)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies a concept from an external specification that roughly corresponds to this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping\"><b>mapping<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Map element to another set of definitions --><\/span>\r\n <<a title=\"The name of the specification is mapping is being expressed to.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping.target\"><b>target<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Which mapping this is (v2, CDA, openEHR, etc.)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Expresses what part of the target specification corresponds to this element.\" class=\"dict\" href=\"profile-definitions.htm#Profile.structure.element.definition.mapping.map\"><b>map<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Details of the mapping<\/span><span style=\"color: Gray\"> --><\/span>\r\n </mapping>\r\n </definition>\r\n </element>\r\n </structure>\r\n <<a title=\"An extension defined as part of the profile.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn\"><b>extensionDefn<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-8: Must define at least one resource constraint, extension definition or binding\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Definition of an extension --><\/span>\r\n <<a title=\"A unique code (within the profile) used to identify the extension.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.code\"><b>code<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-5: Codes must be unique in the context of a profile\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identifies the extension in this profile<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the type of context to which the extension applies.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.contextType\"><b>contextType<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"extension-context.htm\">resource | datatype | mapping | extension<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifies the types of resource or data type elements to which the extension can be applied.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.context\"><b>context<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: navy\">Where the extension can be used in instances<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Definition of the extension and its content.\" class=\"dict\" href=\"profile-definitions.htm#Profile.extensionDefn.definition\"><b>definition<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for Profile.structure.element.definition<\/span> <span style=\"color: navy\">Definition of the extension and its content<\/span><span style=\"color: Gray\"> --><\/span></definition>\r\n </extensionDefn>\r\n <<a title=\"Defines a linkage between a vocabulary binding name used in the profile (or expected to be used in profile importing this one) and a value set or code list.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding\"><b>binding<\/b><\/a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-12: Only complex types can be constrained, not primitive types such as string etc.\" style=\"color: deeppink\"><b>0..*<\/b><\/span> Define code sets for coded elements --><\/span>\r\n <<a title=\"The name to be associated with this set of codes.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-11: Binding name must be unique in the context of a profile\" style=\"color: deeppink\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Binding name<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.isExtensible\"><b>isExtensible<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Can additional codes be used?<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the degree of conformance expectations associated with this binding.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.conformance\"><b>conformance<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-14: Example value sets are always extensible\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"binding-conformance.htm\">required | preferred | example<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Describes the intended use of this particular set of codes.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: provide either a reference or a description\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human explanation of the binding<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Points to the value set or external definition that identifies the set of codes to be used.\" class=\"dict\" href=\"profile-definitions.htm#Profile.binding.reference_x_\"><b>reference[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: provide either a reference or a description\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a>|<a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"valueset.htm#ValueSet\">ValueSet<\/a>)<\/span> <span style=\"color: navy\">Source of binding content<\/span><span style=\"color: Gray\"> --><\/span></reference[x]>\r\n </binding>\r\n</Profile>\r\n<\/pre><\/div>"
},
{
"title":"\"provenance\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/provenance",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/provenance.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Provenance information that describes the activity that lead to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance\"><b>Provenance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The resource(s) that were generated 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.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Target resource(s) (usually version specific)<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"The period during which the activity occurred.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">When the activity occurred<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The instant of time at which the activity was recorded.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.recorded\"><b>recorded<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">When the activity was recorded / updated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The reason that the activity was taking place.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason the activity is occurring<\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"Where the activity occurred, if relevant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the activity occurred, if relevant<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"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.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.policy\"><b>policy<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Policy or plan the activity was defined by<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent\"><b>agent<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Person, organization, records, etc. involved in creating resource --><\/span>\r\n <<a title=\"The role that the participant played.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-role.htm\">author | overseer | enterer | attester | source | cc: +<\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"The type of the participant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-type.htm\">Resource | Person | Application | Record | Document +<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.reference\"><b>reference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identity of agent (urn or url)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human readable description of the participant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of participant<\/span><span style=\"color: Gray\"> --><\/span>\r\n </agent>\r\n <<a title=\"An entity used in this activity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity\"><b>entity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An entity used in this activity --><\/span>\r\n <<a title=\"How the entity was used during the activity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.role\"><b>role<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"provenance-entity-role.htm\">derivation | revision | quotation | source<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of the entity. If the entity is a resource, then this is a resource type.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/vs/resource-types.htm\">Resource Type, or something else<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.reference\"><b>reference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identity of participant (urn or url)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human readable description of the entity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of participant<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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 a shorthand for saying that the agent was responsible for the activity which generated the entity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.agent\"><b>agent<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for Provenance.agent<\/span> <span style=\"color: navy\">Entity is attributed to this agent<\/span><span style=\"color: Gray\"> --><\/span></agent>\r\n </entity>\r\n <<a title=\"A digital signature on the target resource. The signature should reference a participant by xml:id. The signature is only added to support checking cryptographic integrity of the provenance, and not to represent workflow and clinical aspects of the signing process.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.signature\"><b>signature<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Base64 Cryptographic signature of resource (DigSig)<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Provenance>\r\n<\/pre><\/div>"
},
"name":{
"value":"provenance"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Provenance information that describes the activity that lead to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Provenance"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Provenance"
},
"definition":{
"short":{
"value":"Who, What, When for a set of resources"
},
"formal":{
"value":"Provenance information that describes the activity that lead to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"ControlAct[isNormalAct() and subsumes(CACT, classCode) and moodCode=EVN]"
}
},
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Activity"
}
}
]
}
},
{
"path":{
"value":"Provenance.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.target"
},
"definition":{
"short":{
"value":"Target resource(s) (usually version specific)"
},
"formal":{
"value":"The resource(s) that were generated 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":{
"value":"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":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./outboundRelationship[isNormalActRelationship() and typeCode=SUBJ]/target\n\nOR\n\n./participation[isNormalParticipation() and typeCode=SBJ]/role\n\nOR\n\n./participation[isNormalParticipation() and typeCode=SBJ]/role[isNormalRole()]/player"
}
},
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Activity.wasGeneratedBy"
}
}
]
}
},
{
"path":{
"value":"Provenance.period"
},
"definition":{
"short":{
"value":"When the activity occurred"
},
"formal":{
"value":"The period during which the activity occurred."
},
"comments":{
"value":"The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./effectiveTime[type=IVL_TS]"
}
},
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Activity.startTime & Activity.endTime"
}
}
]
}
},
{
"path":{
"value":"Provenance.recorded"
},
"definition":{
"short":{
"value":"When the activity was recorded / updated"
},
"formal":{
"value":"The instant of time at which the activity was recorded."
},
"comments":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isNormalParticipation() and typeCode=AUT]/time[type=TS])"
}
}
]
}
},
{
"path":{
"value":"Provenance.reason"
},
"definition":{
"short":{
"value":"Reason the activity is occurring"
},
"formal":{
"value":"The reason that the activity was taking place."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./reasonCode)"
}
}
]
}
},
{
"path":{
"value":"Provenance.location"
},
"definition":{
"short":{
"value":"Where the activity occurred, if relevant"
},
"formal":{
"value":"Where the activity occurred, if relevant."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isNormalParticipation() and typeCode=LOC]/role[isNormalRole() and subsumes(SDLOC, classCode)]/player[isNormalEntity and classCode=\"LOC\" and determinerCode=\"INST\"]"
}
},
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Activity.location"
}
}
]
}
},
{
"path":{
"value":"Provenance.policy"
},
"definition":{
"short":{
"value":"Policy or plan the activity was defined by"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./inboundRelationship[isNormalActRelationship() and typeCode=\"SUBJ\"]/source[isNormalAct and subsumes(POLICY, classCode) and moodCode=EVN]/text[typeCode='ED'/tel"
}
}
]
}
},
{
"path":{
"value":"Provenance.agent"
},
"definition":{
"short":{
"value":"Person, organization, records, etc. involved in creating resource"
},
"formal":{
"value":"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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility."
},
"comments":{
"value":"Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./participation[isNormalParticipation()]\n\nOR\n\n./outboundRelationship[isNormalActRelationship() and typeCode='DRIV']"
}
}
]
}
},
{
"path":{
"value":"Provenance.agent.role"
},
"definition":{
"short":{
"value":"author | overseer | enterer | attester | source | cc: +"
},
"formal":{
"value":"The role that the participant played."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ProvenanceAgentRole"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"attestor: .[self::participation]/typeCode='RESP'\nauthor: .[self::participation]/typeCode='AUT'\ncc: .[self::participation]/typeCode='IRCP'\nenterer: .[self::participation]/typeCode='ENT'\ninformant: .[self::participation]/typeCode='INF'\nperformer: .[self::participation]/typeCode='PRF'\nverifier: .[self::participation]/typeCode='VRF'\nsource: .[self::outboundRelationship]/typeCode=''"
}
}
]
}
},
{
"path":{
"value":"Provenance.agent.type"
},
"definition":{
"short":{
"value":"Resource | Person | Application | Record | Document +"
},
"formal":{
"value":"The type of the participant."
},
"comments":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ProvenanceAgentType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"person: ./role[isNormalRole() and classCode='REL']/player[isNormalEntity and classCode='PER' and determinerCode='INST']\nagent: ./role[isNormalRole() and classCode='ASSIGNED' and player[isNormalEntity and classCode='PSN' and determinerCode='INST']]\norganization: ./role[isNormalRole() and classCode='ASSIGNED' and not(player)]/scoper[isNormalEntity and classCode='ORG' and determinerCode='INST']\n\nsoftware: ./role[isNormalRole() and classCode='ASSIGNED']/scoper[isNormalEntity and classCode='DEV' and determinerCode='INST' and hasDomain(code, 'Software')]\ndocument: ./target[isNormalAct and subsumes('DOC', classCode) and moodCode='EVN']"
}
}
]
}
},
{
"path":{
"value":"Provenance.agent.reference"
},
"definition":{
"short":{
"value":"Identity of agent (urn or url)"
},
"formal":{
"value":"Identity of participant. May be a logical or physical uri and maybe absolute or relative."
},
"comments":{
"value":"identity may be a reference to a resource or to something else, depending on the type."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./id"
}
}
]
}
},
{
"path":{
"value":"Provenance.agent.display"
},
"definition":{
"short":{
"value":"Human description of participant"
},
"formal":{
"value":"Human readable description of the participant."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./player/description\n\nOR\n\n./description\n\nOR\n\n./text"
}
},
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Agent.label"
}
}
]
}
},
{
"path":{
"value":"Provenance.entity"
},
"definition":{
"short":{
"value":"An entity used in this activity"
},
"formal":{
"value":"An entity used in this activity."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.entity.role"
},
"definition":{
"short":{
"value":"derivation | revision | quotation | source"
},
"formal":{
"value":"How the entity was used during the activity."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ProvenanceEntityRole"
}
}
},
{
"path":{
"value":"Provenance.entity.type"
},
"definition":{
"short":{
"value":"Resource Type, or something else"
},
"formal":{
"value":"The type of the entity. If the entity is a resource, then this is a resource type."
},
"comments":{
"value":"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":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"ProvenanceEntityType"
},
"mapping":[
{
"target":{
"value":"http://www.w3.org/ns/prov"
},
"map":{
"value":"Entity.type"
}
}
]
}
},
{
"path":{
"value":"Provenance.entity.reference"
},
"definition":{
"short":{
"value":"Identity of participant (urn or url)"
},
"formal":{
"value":"Identity of participant. May be a logical or physical uri and maybe absolute or relative."
},
"comments":{
"value":"identity may be a reference to a resource or to something else, depending on the type."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.entity.display"
},
"definition":{
"short":{
"value":"Human description of participant"
},
"formal":{
"value":"Human readable description of the entity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.entity.agent"
},
"definition":{
"short":{
"value":"Entity is attributed to this agent"
},
"formal":{
"value":"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 a shorthand for saying that the agent was responsible for the activity which generated the entity."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"@Provenance.agent"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Provenance.signature"
},
"definition":{
"short":{
"value":"Base64 Cryptographic signature of resource (DigSig)"
},
"formal":{
"value":"A digital signature on the target resource. The signature should reference a participant by xml:id. The signature is only added to support checking cryptographic integrity of the provenance, and not to represent workflow and clinical aspects of the signing process."
},
"comments":{
"value":"Whether the content is xml or json, the representation is as a base64 of the XML signature of the resource."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./signatureText"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"ProvenanceEntityRole"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/provenance-entity-role"
}
}
},
{
"name":{
"value":"ProvenanceAgentRole"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/provenance-agent-role"
}
}
},
{
"name":{
"value":"ProvenanceAgentType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/provenance-agent-type"
}
}
},
{
"name":{
"value":"ProvenanceEntityType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/resource-types"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Provenance information that describes the activity that lead to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance\"><b>Provenance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The resource(s) that were generated 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.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Target resource(s) (usually version specific)<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n <<a title=\"The period during which the activity occurred.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.period\"><b>period<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">When the activity occurred<\/span><span style=\"color: Gray\"> --><\/span></period>\r\n <<a title=\"The instant of time at which the activity was recorded.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.recorded\"><b>recorded<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">When the activity was recorded / updated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The reason that the activity was taking place.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.reason\"><b>reason<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\">Reason the activity is occurring<\/span><span style=\"color: Gray\"> --><\/span></reason>\r\n <<a title=\"Where the activity occurred, if relevant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.location\"><b>location<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the activity occurred, if relevant<\/span><span style=\"color: Gray\"> --><\/span></location>\r\n <<a title=\"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.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.policy\"><b>policy<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Policy or plan the activity was defined by<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent\"><b>agent<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Person, organization, records, etc. involved in creating resource --><\/span>\r\n <<a title=\"The role that the participant played.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-role.htm\">author | overseer | enterer | attester | source | cc: +<\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"The type of the participant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-provenance-agent-type.htm\">Resource | Person | Application | Record | Document +<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.reference\"><b>reference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identity of agent (urn or url)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human readable description of the participant.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.agent.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of participant<\/span><span style=\"color: Gray\"> --><\/span>\r\n </agent>\r\n <<a title=\"An entity used in this activity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity\"><b>entity<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> An entity used in this activity --><\/span>\r\n <<a title=\"How the entity was used during the activity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.role\"><b>role<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"provenance-entity-role.htm\">derivation | revision | quotation | source<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of the entity. If the entity is a resource, then this is a resource type.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://hl7.org/fhir/vs/resource-types.htm\">Resource Type, or something else<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identity of participant. May be a logical or physical uri and maybe absolute or relative.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.reference\"><b>reference<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Identity of participant (urn or url)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human readable description of the entity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.display\"><b>display<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human description of participant<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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 a shorthand for saying that the agent was responsible for the activity which generated the entity.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.entity.agent\"><b>agent<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\">Content as for Provenance.agent<\/span> <span style=\"color: navy\">Entity is attributed to this agent<\/span><span style=\"color: Gray\"> --><\/span></agent>\r\n </entity>\r\n <<a title=\"A digital signature on the target resource. The signature should reference a participant by xml:id. The signature is only added to support checking cryptographic integrity of the provenance, and not to represent workflow and clinical aspects of the signing process.\" class=\"dict\" href=\"provenance-definitions.htm#Provenance.signature\"><b>signature<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Base64 Cryptographic signature of resource (DigSig)<\/span><span style=\"color: Gray\"> --><\/span>\r\n</Provenance>\r\n<\/pre><\/div>"
},
{
"title":"\"query\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/query",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/query.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A description of a query with a set of parameters.\" class=\"dict\" href=\"query-definitions.htm#Query\"><b>Query<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Links query and its response(s).\" class=\"dict\" href=\"query-definitions.htm#Query.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Links query and its response(s)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Set of query parameters with values.\" class=\"dict\" href=\"query-definitions.htm#Query.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">Set of query parameters with values<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n <<a title=\"If this is a response to a query.\" class=\"dict\" href=\"query-definitions.htm#Query.response\"><b>response<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this is a response to a query --><\/span>\r\n <<a title=\"Links response to source query.\" class=\"dict\" href=\"query-definitions.htm#Query.response.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Links response to source query<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Outcome of processing the query.\" class=\"dict\" href=\"query-definitions.htm#Query.response.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"query-outcome.htm\">Outcome of processing the query<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Total number of matching records.\" class=\"dict\" href=\"query-definitions.htm#Query.response.total\"><b>total<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Total number of matching records<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Parameters server used.\" class=\"dict\" href=\"query-definitions.htm#Query.response.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">Parameters server used<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n <<a title=\"To get first page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.first\"><b>first<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get first page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></first>\r\n <<a title=\"To get previous page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.previous\"><b>previous<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get previous page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></previous>\r\n <<a title=\"To get next page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.next\"><b>next<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get next page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></next>\r\n <<a title=\"To get last page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.last\"><b>last<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get last page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></last>\r\n <<a title=\"Resources that are the results of the search.\" class=\"dict\" href=\"query-definitions.htm#Query.response.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Resources that are the results of the search<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n </response>\r\n</Query>\r\n<\/pre><\/div>"
},
"name":{
"value":"query"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A description of a query with a set of parameters."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Query"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Query"
},
"definition":{
"short":{
"value":"A description of a query with a set of parameters"
},
"formal":{
"value":"A description of a query with a set of parameters."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.identifier"
},
"definition":{
"short":{
"value":"Links query and its response(s)"
},
"formal":{
"value":"Links query and its response(s)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.parameter"
},
"definition":{
"short":{
"value":"Set of query parameters with values"
},
"formal":{
"value":"Set of query parameters with values."
},
"comments":{
"value":"Unless otherwise specified, parameters are usually strings."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response"
},
"definition":{
"short":{
"value":"If this is a response to a query"
},
"formal":{
"value":"If this is a response to a query."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.identifier"
},
"definition":{
"short":{
"value":"Links response to source query"
},
"formal":{
"value":"Links response to source query."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.outcome"
},
"definition":{
"short":{
"value":"Outcome of processing the query"
},
"formal":{
"value":"Outcome of processing the query."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"QueryOutcome"
}
}
},
{
"path":{
"value":"Query.response.total"
},
"definition":{
"short":{
"value":"Total number of matching records"
},
"formal":{
"value":"Total number of matching records."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"integer"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.parameter"
},
"definition":{
"short":{
"value":"Parameters server used"
},
"formal":{
"value":"Parameters server used."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.first"
},
"definition":{
"short":{
"value":"To get first page (if paged)"
},
"formal":{
"value":"To get first page (if paged)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.previous"
},
"definition":{
"short":{
"value":"To get previous page (if paged)"
},
"formal":{
"value":"To get previous page (if paged)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.next"
},
"definition":{
"short":{
"value":"To get next page (if paged)"
},
"formal":{
"value":"To get next page (if paged)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.last"
},
"definition":{
"short":{
"value":"To get last page (if paged)"
},
"formal":{
"value":"To get last page (if paged)."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Query.response.reference"
},
"definition":{
"short":{
"value":"Resources that are the results of the search"
},
"formal":{
"value":"Resources that are the results of the search."
},
"comments":{
"value":"Is query only used in messaging?."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"QueryOutcome"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/query-outcome"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A description of a query with a set of parameters.\" class=\"dict\" href=\"query-definitions.htm#Query\"><b>Query<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Links query and its response(s).\" class=\"dict\" href=\"query-definitions.htm#Query.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Links query and its response(s)<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Set of query parameters with values.\" class=\"dict\" href=\"query-definitions.htm#Query.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">Set of query parameters with values<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n <<a title=\"If this is a response to a query.\" class=\"dict\" href=\"query-definitions.htm#Query.response\"><b>response<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> If this is a response to a query --><\/span>\r\n <<a title=\"Links response to source query.\" class=\"dict\" href=\"query-definitions.htm#Query.response.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Links response to source query<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Outcome of processing the query.\" class=\"dict\" href=\"query-definitions.htm#Query.response.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"query-outcome.htm\">Outcome of processing the query<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Total number of matching records.\" class=\"dict\" href=\"query-definitions.htm#Query.response.total\"><b>total<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#integer\">integer<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Total number of matching records<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Parameters server used.\" class=\"dict\" href=\"query-definitions.htm#Query.response.parameter\"><b>parameter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">Parameters server used<\/span><span style=\"color: Gray\"> --><\/span></parameter>\r\n <<a title=\"To get first page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.first\"><b>first<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get first page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></first>\r\n <<a title=\"To get previous page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.previous\"><b>previous<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get previous page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></previous>\r\n <<a title=\"To get next page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.next\"><b>next<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get next page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></next>\r\n <<a title=\"To get last page (if paged).\" class=\"dict\" href=\"query-definitions.htm#Query.response.last\"><b>last<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"extensibility.htm#Extension\">Extension<\/a><\/span> <span style=\"color: navy\">To get last page (if paged)<\/span><span style=\"color: Gray\"> --><\/span></last>\r\n <<a title=\"Resources that are the results of the search.\" class=\"dict\" href=\"query-definitions.htm#Query.response.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Resources that are the results of the search<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n </response>\r\n</Query>\r\n<\/pre><\/div>"
},
{
"title":"\"questionnaire\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/questionnaire",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/questionnaire.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A set of answers to predefined lists of questions. The questions may be ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire\"><b>Questionnaire<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The status of the questionnaire as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">registered|interim|final|amended|cancelled|withdrawn<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date and/or time that this version of the questionnaire was authored.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.authored\"><b>authored<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date this version was authored<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">The subject of the questionnaires<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Person that collected the answers to the questions in the Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">Person that collected the answers<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"The person that answered the questions about the subject. Only used when this is not the subject him/herself.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">The person that answered the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"Structured name for a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-name.htm\">Name/code for a predefined list of questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"An identifier that identifier this specific set of answers.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identification of this questionnaire<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Encounter during which this questionnaireanswers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Primary encounter during which the answers were collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Answers to questions on a questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question\"><b>question<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Answers to questions --><\/span>\r\n <<a title=\"Structured name for the question.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-question-name.htm\">Code or name of the question<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Text of the question as it may appear on screen or on a form.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text of the question<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Single-valued answer to the question.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.answer_x_\"><b>answer[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a>|<a href=\"datatypes.htm#integer\">integer<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a>|\r\n <a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#instant\">instant<\/a><\/span> <span style=\"color: navy\">Single-valued answer to the question<\/span><span style=\"color: Gray\"> --><\/span></answer[x]>\r\n <<a title=\"One of more selections from the list of options.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.choice\"><b>choice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Selected options<\/span><span style=\"color: Gray\"> --><\/span></choice>\r\n <<a title=\"Reference to a valueset containing the possible options.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.options_x_\"><b>options[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a>|<a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"valueset.htm#ValueSet\">ValueSet<\/a>)<\/span> <span style=\"color: navy\">Valueset containing the possible options<\/span><span style=\"color: Gray\"> --><\/span></options[x]>\r\n <<a title=\"Structured answer in the form of a FHIR Resource or datatype.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.data_x_\"><b>data[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Structured answer<\/span><span style=\"color: Gray\"> --><\/span></data[x]>\r\n <<a title=\"The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.remarks\"><b>remarks<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Remarks about the answer given<\/span><span style=\"color: Gray\"> --><\/span>\r\n </question>\r\n <<a title=\"A group of questions to a possibly similarly grouped set of question in the questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group\"><b>group<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Grouped answers --><\/span>\r\n <<a title=\"Structured name for a section of a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-group-name.htm\">Code or name of the section on a questionnaire<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Header for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.header\"><b>header<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Header for the group<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional text for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional text for the group<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"More specific subject this section's answers are about, details the subject given in Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The subject this group's answers are about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Set of questions within this group.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.question\"><b>question<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Questionnaire.question<\/span> <span style=\"color: navy\">Questions belonging to this group<\/span><span style=\"color: Gray\"> --><\/span></question>\r\n <<a title=\"A sub-group within a group.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Questionnaire.group<\/span> <span style=\"color: navy\">Nested questionnaire group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n </group>\r\n</Questionnaire>\r\n<\/pre><\/div>"
},
"name":{
"value":"questionnaire"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A set of answers to predefined lists of questions. The questions may be ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Questionnaire"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Questionnaire"
},
"definition":{
"short":{
"value":"A set of answers to predefined lists of questions"
},
"formal":{
"value":"A set of answers to predefined lists of questions. The questions may be ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.status"
},
"definition":{
"short":{
"value":"registered|interim|final|amended|cancelled|withdrawn"
},
"formal":{
"value":"The status of the questionnaire as a whole."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"ObservationStatus"
}
}
},
{
"path":{
"value":"Questionnaire.authored"
},
"definition":{
"short":{
"value":"Date this version was authored"
},
"formal":{
"value":"The date and/or time that this version of the questionnaire was authored."
},
"comments":{
"value":"May be different from the update time of the resource itself, because that is the status of the collection and authoring."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.subject"
},
"definition":{
"short":{
"value":"The subject of the questionnaires"
},
"formal":{
"value":"The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|RelatedPerson)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.author"
},
"definition":{
"short":{
"value":"Person that collected the answers"
},
"formal":{
"value":"Person that collected the answers to the questions in the Questionnaire."
},
"comments":{
"value":"Mapping a subject's answers to multiple choice options and determining what to put in textual answer is a matter of interpretation."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient|RelatedPerson)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.source"
},
"definition":{
"short":{
"value":"The person that answered the questions"
},
"formal":{
"value":"The person that answered the questions about the subject. Only used when this is not the subject him/herself."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Practitioner|RelatedPerson)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.name"
},
"definition":{
"short":{
"value":"Name/code for a predefined list of questions"
},
"formal":{
"value":"Structured name for a predefined list of questions this questionnaire is responding to."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"QuestionnaireName"
}
}
},
{
"path":{
"value":"Questionnaire.identifier"
},
"definition":{
"short":{
"value":"Identification of this questionnaire"
},
"formal":{
"value":"An identifier that identifier this specific set of answers."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.encounter"
},
"definition":{
"short":{
"value":"Primary encounter during which the answers were collected"
},
"formal":{
"value":"Encounter during which this questionnaireanswers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Encounter)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question"
},
"definition":{
"short":{
"value":"Answers to questions"
},
"formal":{
"value":"Answers to questions on a questionnaire."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"1"
},
"name":{
"value":"SimpleChoiceOrData"
},
"severity":{
"value":"error"
},
"human":{
"value":"Must supply either a simple answer, a choice, data or nothing"
},
"xpath":{
"value":"count(f:data) + count(f:choice) + count(f:value) <= 1"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.name"
},
"definition":{
"short":{
"value":"Code or name of the question"
},
"formal":{
"value":"Structured name for the question."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"QuestionName"
}
}
},
{
"path":{
"value":"Questionnaire.question.text"
},
"definition":{
"short":{
"value":"Text of the question"
},
"formal":{
"value":"Text of the question as it may appear on screen or on a form."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.answer[x]"
},
"definition":{
"short":{
"value":"Single-valued answer to the question"
},
"formal":{
"value":"Single-valued answer to the question."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"decimal"
}
},
{
"code":{
"value":"integer"
}
},
{
"code":{
"value":"boolean"
}
},
{
"code":{
"value":"date"
}
},
{
"code":{
"value":"string"
}
},
{
"code":{
"value":"dateTime"
}
},
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.choice"
},
"definition":{
"short":{
"value":"Selected options"
},
"formal":{
"value":"One of more selections from the list of options."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.options[x]"
},
"definition":{
"short":{
"value":"Valueset containing the possible options"
},
"formal":{
"value":"Reference to a valueset containing the possible options."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"uri"
}
},
{
"code":{
"value":"Resource(ValueSet)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.data[x]"
},
"definition":{
"short":{
"value":"Structured answer"
},
"formal":{
"value":"Structured answer in the form of a FHIR Resource or datatype."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"*"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.question.remarks"
},
"definition":{
"short":{
"value":"Remarks about the answer given"
},
"formal":{
"value":"The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group"
},
"definition":{
"short":{
"value":"Grouped answers"
},
"formal":{
"value":"A group of questions to a possibly similarly grouped set of question in the questionnaire."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group.name"
},
"definition":{
"short":{
"value":"Code or name of the section on a questionnaire"
},
"formal":{
"value":"Structured name for a section of a predefined list of questions this questionnaire is responding to."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"QuestionnaireGroupName"
}
}
},
{
"path":{
"value":"Questionnaire.group.header"
},
"definition":{
"short":{
"value":"Header for the group"
},
"formal":{
"value":"Header for the group, used for display purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group.text"
},
"definition":{
"short":{
"value":"Additional text for the group"
},
"formal":{
"value":"Additional text for the group, used for display purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group.subject"
},
"definition":{
"short":{
"value":"The subject this group's answers are about"
},
"formal":{
"value":"More specific subject this section's answers are about, details the subject given in Questionnaire."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group.question"
},
"definition":{
"short":{
"value":"Questions belonging to this group"
},
"formal":{
"value":"Set of questions within this group."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@Questionnaire.question"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Questionnaire.group.group"
},
"definition":{
"short":{
"value":"Nested questionnaire group"
},
"formal":{
"value":"A sub-group within a group."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"@Questionnaire.group"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"QuestionnaireName"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/questionnaire-name"
}
}
},
{
"name":{
"value":"QuestionName"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/questionnaire-question-name"
}
}
},
{
"name":{
"value":"QuestionnaireGroupName"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/questionnaire-group-name"
}
}
},
{
"name":{
"value":"ObservationStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/observation-status"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A set of answers to predefined lists of questions. The questions may be ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire\"><b>Questionnaire<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"The status of the questionnaire as a whole (this element modifies the meaning of other elements)\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"observation-status.htm\">registered|interim|final|amended|cancelled|withdrawn<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The date and/or time that this version of the questionnaire was authored.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.authored\"><b>authored<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Date this version was authored<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The subject of the questionnaires: this is the patient that the answers apply to, but this person is not necessarily the source of information.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">The subject of the questionnaires<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Person that collected the answers to the questions in the Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.author\"><b>author<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">Person that collected the answers<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></author>\r\n <<a title=\"The person that answered the questions about the subject. Only used when this is not the subject him/herself.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.source\"><b>source<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"relatedperson.htm#RelatedPerson\">RelatedPerson<\/a>)<\/span> <span style=\"color: navy\">The person that answered the questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></source>\r\n <<a title=\"Structured name for a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-name.htm\">Name/code for a predefined list of questions<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"An identifier that identifier this specific set of answers.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identification of this questionnaire<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Encounter during which this questionnaireanswers were collected. When there were multiple encounters, this is the one considered most relevant to the context of the answers.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.encounter\"><b>encounter<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"encounter.htm#Encounter\">Encounter<\/a>)<\/span> <span style=\"color: navy\">Primary encounter during which the answers were collected<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></encounter>\r\n <<a title=\"Answers to questions on a questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question\"><b>question<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Answers to questions --><\/span>\r\n <<a title=\"Structured name for the question.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-question-name.htm\">Code or name of the question<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Text of the question as it may appear on screen or on a form.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Text of the question<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Single-valued answer to the question.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.answer_x_\"><b>answer[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#decimal\">decimal<\/a>|<a href=\"datatypes.htm#integer\">integer<\/a>|<a href=\"datatypes.htm#boolean\">boolean<\/a>|\r\n <a href=\"datatypes.htm#date\">date<\/a>|<a href=\"datatypes.htm#string\">string<\/a>|<a href=\"datatypes.htm#dateTime\">dateTime<\/a>|<a href=\"datatypes.htm#instant\">instant<\/a><\/span> <span style=\"color: navy\">Single-valued answer to the question<\/span><span style=\"color: Gray\"> --><\/span></answer[x]>\r\n <<a title=\"One of more selections from the list of options.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.choice\"><b>choice<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Selected options<\/span><span style=\"color: Gray\"> --><\/span></choice>\r\n <<a title=\"Reference to a valueset containing the possible options.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.options_x_\"><b>options[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#uri\">uri<\/a>|<a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"valueset.htm#ValueSet\">ValueSet<\/a>)<\/span> <span style=\"color: navy\">Valueset containing the possible options<\/span><span style=\"color: Gray\"> --><\/span></options[x]>\r\n <<a title=\"Structured answer in the form of a FHIR Resource or datatype.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.data_x_\"><b>data[x]<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Must supply either a simple answer, a choice, data or nothing\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#open\">*<\/a><\/span> <span style=\"color: navy\">Structured answer<\/span><span style=\"color: Gray\"> --><\/span></data[x]>\r\n <<a title=\"The remark contains information about the answer given. This is additional information about the answer the author wishes to convey, but should not be used to contain information that is part of the answer itself.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.question.remarks\"><b>remarks<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Remarks about the answer given<\/span><span style=\"color: Gray\"> --><\/span>\r\n </question>\r\n <<a title=\"A group of questions to a possibly similarly grouped set of question in the questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group\"><b>group<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Grouped answers --><\/span>\r\n <<a title=\"Structured name for a section of a predefined list of questions this questionnaire is responding to.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-questionnaire-group-name.htm\">Code or name of the section on a questionnaire<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Header for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.header\"><b>header<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Header for the group<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional text for the group, used for display purposes.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.text\"><b>text<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Additional text for the group<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"More specific subject this section's answers are about, details the subject given in Questionnaire.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">The subject this group's answers are about<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"Set of questions within this group.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.question\"><b>question<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Questionnaire.question<\/span> <span style=\"color: navy\">Questions belonging to this group<\/span><span style=\"color: Gray\"> --><\/span></question>\r\n <<a title=\"A sub-group within a group.\" class=\"dict\" href=\"questionnaire-definitions.htm#Questionnaire.group.group\"><b>group<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\">Content as for Questionnaire.group<\/span> <span style=\"color: navy\">Nested questionnaire group<\/span><span style=\"color: Gray\"> --><\/span></group>\r\n </group>\r\n</Questionnaire>\r\n<\/pre><\/div>"
},
{
"title":"\"relatedperson\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/relatedperson",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/relatedperson.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson\"><b>RelatedPerson<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier for a person within a particular scope.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">A Human identifier for this person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The patient this person is related to.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The patient this person is related to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The nature of the relationship between a patient and the related person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-relatedperson-relationshiptype.htm\">The nature of the relationship<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"Address where the related person can be contacted or visited.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Address where the related person can be contacted or visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n</RelatedPerson>\r\n<\/pre><\/div>"
},
"name":{
"value":"relatedperson"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"RelatedPerson"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"RelatedPerson"
},
"definition":{
"short":{
"value":"An person that is related to a patient, but who is not a direct target of care"
},
"formal":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"Person(classCode=\"PSN\" and determinerCode=\"INST\" and quantity=\"1\")"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"RelatedPerson.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"RelatedPerson.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"RelatedPerson.identifier"
},
"definition":{
"short":{
"value":"A Human identifier for this person"
},
"formal":{
"value":"Identifier for a person within a particular scope."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":".plays:Role(classCode='IDENT').id"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-33"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.patient"
},
"definition":{
"short":{
"value":"The patient this person is related to"
},
"formal":{
"value":"The patient this person is related to."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"PID-3"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.relationship"
},
"definition":{
"short":{
"value":"The nature of the relationship"
},
"formal":{
"value":"The nature of the relationship between a patient and the related person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"PatientRelationshipType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-3"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.name"
},
"definition":{
"short":{
"value":"A name associated with the person"
},
"formal":{
"value":"A name associated with the person."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"HumanName"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./name"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-2"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.telecom"
},
"definition":{
"short":{
"value":"A contact detail for the person"
},
"formal":{
"value":"A contact detail for the person, e.g. a telephone number or an email address."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Contact"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./telecom"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-5 / NK1-6 / NK1-40"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.gender"
},
"definition":{
"short":{
"value":"Gender for administrative purposes"
},
"formal":{
"value":"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"AdministrativeGender"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./administrativeGender"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-15"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.address"
},
"definition":{
"short":{
"value":"Address where the related person can be contacted or visited"
},
"formal":{
"value":"Address where the related person can be contacted or visited."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Address"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./addr"
}
},
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"NK1-4"
}
}
]
}
},
{
"path":{
"value":"RelatedPerson.photo"
},
"definition":{
"short":{
"value":"Image of the person"
},
"formal":{
"value":"Image of the person."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Attachment"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"OBX-5 - needs a profile"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"AdministrativeGender"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/administrative-gender"
}
}
},
{
"name":{
"value":"PatientRelationshipType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/relatedperson-relationshiptype"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson\"><b>RelatedPerson<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier for a person within a particular scope.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">A Human identifier for this person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The patient this person is related to.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">The patient this person is related to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"The nature of the relationship between a patient and the related person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.relationship\"><b>relationship<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-relatedperson-relationshiptype.htm\">The nature of the relationship<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></relationship>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#HumanName\">HumanName<\/a><\/span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"A contact detail for the person, e.g. a telephone number or an email address.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.telecom\"><b>telecom<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Contact\">Contact<\/a><\/span> <span style=\"color: navy\">A contact detail for the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></telecom>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.gender\"><b>gender<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.htm\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/a><\/span><span style=\"color: Gray\"> --><\/span></gender>\r\n <<a title=\"Address where the related person can be contacted or visited.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.address\"><b>address<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Address\">Address<\/a><\/span> <span style=\"color: navy\">Address where the related person can be contacted or visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §<\/span><\/span><span style=\"color: Gray\"> --><\/span></address>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"relatedperson-definitions.htm#RelatedPerson.photo\"><b>photo<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Attachment\">Attachment<\/a><\/span> <span style=\"color: navy\">Image of the person<\/span><span style=\"color: Gray\"> --><\/span></photo>\r\n</RelatedPerson>\r\n<\/pre><\/div>"
},
{
"title":"\"securityevent\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/securityevent",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/securityevent.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent\"><b>SecurityEvent<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies the name, action type, time, and disposition of the audited event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> What was done --><\/span>\r\n <<a title=\"Identifier for a family of the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-type.htm\">Type of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identifier for the category of event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sub-type.htm\">Sub-type of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Indicator for type of action performed during the event that generated the audit.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.action\"><b>action<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-action.htm\">Type of action performed during the event<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The time when the event occurred on the source.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time when the event occurred on source<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates whether the event succeeded or failed.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-outcome.htm\">Whether the event succeeded or failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text description of the outcome of the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.outcomeDesc\"><b>outcomeDesc<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the event outcome<\/span><span style=\"color: Gray\"> --><\/span>\r\n </event>\r\n <<a title=\"A person, a hardware device or software process.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A person, a hardware device or software process --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-dicm-402-roleid.htm\">User roles (e.g. local RBAC codes)<\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"Direct reference to a resource that identifies the participant.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Either an userId or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Direct reference to resource<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n <<a title=\"Unique identifier for the user actively participating in the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.userId\"><b>userId<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Either an userId or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Unique identifier for the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.authId\"><b>authId<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">User id used by authentication system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human-meaningful name for the user.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human-meaningful name for the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicator that the user is or is not the requestor, or initiator, for the event being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.requestor\"><b>requestor<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Whether user is initiator<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of media involved. Used when the event is about exporting/importing onto media.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.media\"><b>media<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Type of media<\/span><span style=\"color: Gray\"> --><\/span></media>\r\n <<a title=\"Logical network location for application activity, if the activity has a network location.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network\"><b>network<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Logical network location for application activity --><\/span>\r\n <<a title=\"An identifier for the network access point of the user device for the audit event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Identifier for the network access point of the user device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An identifier for the type of network access point that originated the audit event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"network-type.htm\">The type of network access point<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </network>\r\n </participant>\r\n <<a title=\"Application systems and processes.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Application systems and processes --><\/span>\r\n <<a title=\"Logical source location within the healthcare enterprise network.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.site\"><b>site<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical source location within the enterprise<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifier of the source where the event originated.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The id of source where event originated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code specifying the type of source where event originated.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-source-type.htm\">The type of source where event originated<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n </source>\r\n <<a title=\"Specific instances of data or objects that have been accessed.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object\"><b>object<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specific instances of data or objects that have been accessed --><\/span>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Specific instance of object (e.g. versioned)<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Specific instance of resource (e.g. versioned)<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n <<a title=\"Object type being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-type.htm\">Object type being audited<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code representing the functional application role of Participant Object being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.role\"><b>role<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-role.htm\">Functional application role of Object<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifier for the data life-cycle stage for the participant object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.lifecycle\"><b>lifecycle<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-lifecycle.htm\">Life-cycle stage for the object<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.sensitivity\"><b>sensitivity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sensitivity.htm\">Policy-defined sensitivity for the object<\/a><\/span><span style=\"color: Gray\"> --><\/span></sensitivity>\r\n <<a title=\"An instance-specific descriptor of the Participant Object ID audited, such as a person's name.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Instance-specific descriptor for Object<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The actual query for a query-type participant object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.query\"><b>query<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual query for object<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional Information about the Object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail\"><b>detail<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional Information about the Object --><\/span>\r\n <<a title=\"Name of the property.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the property<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Property value.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Property value<\/span><span style=\"color: Gray\"> --><\/span>\r\n </detail>\r\n </object>\r\n</SecurityEvent>\r\n<\/pre><\/div>"
},
"name":{
"value":"securityevent"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. 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."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"SecurityEvent"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"SecurityEvent"
},
"definition":{
"short":{
"value":"Event record kept for security purposes"
},
"formal":{
"value":"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":{
"value":"Based on ATNA (RFC 3881)."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"Message"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"SecurityEvent.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"SecurityEvent.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"SecurityEvent.event"
},
"definition":{
"short":{
"value":"What was done"
},
"formal":{
"value":"Identifies the name, action type, time, and disposition of the audited event."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"EventIdentification"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.type"
},
"definition":{
"short":{
"value":"Type of event"
},
"formal":{
"value":"Identifier for a family of the event."
},
"comments":{
"value":"e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventType"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventId"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.subtype"
},
"definition":{
"short":{
"value":"Sub-type of event"
},
"formal":{
"value":"Identifier for the category of event."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventSubType"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventTypeCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.action"
},
"definition":{
"short":{
"value":"Type of action performed during the event"
},
"formal":{
"value":"Indicator for type of action performed during the event that generated the audit."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventAction"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventActionCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.dateTime"
},
"definition":{
"short":{
"value":"Time when the event occurred on source"
},
"formal":{
"value":"The time when the event occurred on the source."
},
"comments":{
"value":"In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"instant"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventDateTime"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.outcome"
},
"definition":{
"short":{
"value":"Whether the event succeeded or failed"
},
"formal":{
"value":"Indicates whether the event succeeded or failed."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventOutcome"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventOutcomeIndicator"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.event.outcomeDesc"
},
"definition":{
"short":{
"value":"Description of the event outcome"
},
"formal":{
"value":"A free text description of the outcome of the event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@EventOutcomeDescription"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant"
},
"definition":{
"short":{
"value":"A person, a hardware device or software process"
},
"formal":{
"value":"A person, a hardware device or software process."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"3"
},
"name":{
"value":"Participant Identification"
},
"severity":{
"value":"error"
},
"human":{
"value":"Either an userId or a reference, but not both"
},
"xpath":{
"value":"exists(f:userId) != exists(f:reference)"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"ActiveParticipant"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.role"
},
"definition":{
"short":{
"value":"User roles (e.g. local RBAC codes)"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"DicomRoleId"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"RoleIdCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.reference"
},
"definition":{
"short":{
"value":"Direct reference to resource"
},
"formal":{
"value":"Direct reference to a resource that identifies the participant."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner|Patient|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"SecurityEvent.participant.userId"
},
"definition":{
"short":{
"value":"Unique identifier for the user"
},
"formal":{
"value":"Unique identifier for the user actively participating in the event."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@UserId"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.authId"
},
"definition":{
"short":{
"value":"User id used by authentication system"
},
"formal":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@AlternativeUserId"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.name"
},
"definition":{
"short":{
"value":"Human-meaningful name for the user"
},
"formal":{
"value":"Human-meaningful name for the user."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@UserName"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.requestor"
},
"definition":{
"short":{
"value":"Whether user is initiator"
},
"formal":{
"value":"Indicator that the user is or is not the requestor, or initiator, for the event being audited."
},
"comments":{
"value":"There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"boolean"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@UserIsRequestor"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.media"
},
"definition":{
"short":{
"value":"Type of media"
},
"formal":{
"value":"Type of media involved. Used when the event is about exporting/importing onto media."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"MediaType"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.network"
},
"definition":{
"short":{
"value":"Logical network location for application activity"
},
"formal":{
"value":"Logical network location for application activity, if the activity has a network location."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"SecurityEvent.participant.network.identifier"
},
"definition":{
"short":{
"value":"Identifier for the network access point of the user device"
},
"formal":{
"value":"An identifier for the network access point of the user device for the audit event."
},
"comments":{
"value":"This could be a device id, IP address or some other identifier associated with a device."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@NetWorkAccessPointID"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.participant.network.type"
},
"definition":{
"short":{
"value":"The type of network access point"
},
"formal":{
"value":"An identifier for the type of network access point that originated the audit event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventParticipantNetworkType"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@NetworkAccessPointTypeCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.source"
},
"definition":{
"short":{
"value":"Application systems and processes"
},
"formal":{
"value":"Application systems and processes."
},
"comments":{
"value":"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."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"AuditSourceIdentification"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.source.site"
},
"definition":{
"short":{
"value":"Logical source location within the enterprise"
},
"formal":{
"value":"Logical source location within the healthcare enterprise network."
},
"comments":{
"value":"a hospital or other provider location within a multi-entity provider group."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@AuditEnterpriseSiteId"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.source.identifier"
},
"definition":{
"short":{
"value":"The id of source where event originated"
},
"formal":{
"value":"Identifier of the source where the event originated."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@AuditSourceId"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.source.type"
},
"definition":{
"short":{
"value":"The type of source where event originated"
},
"formal":{
"value":"Code specifying the type of source where event originated."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Coding"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventSourceType"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"AuditSourceTypeCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object"
},
"definition":{
"short":{
"value":"Specific instances of data or objects that have been accessed"
},
"formal":{
"value":"Specific instances of data or objects that have been accessed."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"constraint":[
{
"key":{
"value":"2"
},
"name":{
"value":"Object Identification"
},
"severity":{
"value":"error"
},
"human":{
"value":"Either an identifier or a reference, but not both"
},
"xpath":{
"value":"exists(f:identifier) != exists(f:reference)"
}
},
{
"key":{
"value":"1"
},
"name":{
"value":"Object Name"
},
"severity":{
"value":"error"
},
"human":{
"value":"Either a name or a query (or both)"
},
"xpath":{
"value":"not(exists(f:name)) or not(exists(f:query))"
}
}
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"ParticipantObjectIdentification"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.identifier"
},
"definition":{
"short":{
"value":"Specific instance of object (e.g. versioned)"
},
"formal":{
"value":"Identifies a specific instance of the participant object. The reference should always be version specific."
},
"comments":{
"value":"Identifier details depends on object type."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectID"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.reference"
},
"definition":{
"short":{
"value":"Specific instance of resource (e.g. versioned)"
},
"formal":{
"value":"Identifies a specific instance of the participant object. The reference should always be version specific."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Any)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectID"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.type"
},
"definition":{
"short":{
"value":"Object type being audited"
},
"formal":{
"value":"Object type being audited."
},
"comments":{
"value":"This value is distinct from the user's role or any user relationship to the participant object."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventObjectType"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectTypeCode"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.role"
},
"definition":{
"short":{
"value":"Functional application role of Object"
},
"formal":{
"value":"Code representing the functional application role of Participant Object being audited."
},
"comments":{
"value":"See Rfc 3881 for rules concerning matches between role and type."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventObjectRole"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectTypeCodeRole"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.lifecycle"
},
"definition":{
"short":{
"value":"Life-cycle stage for the object"
},
"formal":{
"value":"Identifier for the data life-cycle stage for the participant object."
},
"comments":{
"value":"This can be used to provide an audit trail for data, over time, as it passes through the system."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventObjectLifecycle"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectDataLifeCycle"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.sensitivity"
},
"definition":{
"short":{
"value":"Policy-defined sensitivity for the object"
},
"formal":{
"value":"Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."
},
"comments":{
"value":"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."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SecurityEventObjectSensitivity"
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@ParticipantObjectSensitivity"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.name"
},
"definition":{
"short":{
"value":"Instance-specific descriptor for Object"
},
"formal":{
"value":"An instance-specific descriptor of the Participant Object ID audited, such as a person's name."
},
"comments":{
"value":"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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"ParticipantObjectName"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.query"
},
"definition":{
"short":{
"value":"Actual query for object"
},
"formal":{
"value":"The actual query for a query-type participant object."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"base64Binary"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"ParticipantObjectQuery"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.detail"
},
"definition":{
"short":{
"value":"Additional Information about the Object"
},
"formal":{
"value":"Additional Information about the Object."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"ParticipantObjectDetail"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.detail.type"
},
"definition":{
"short":{
"value":"Name of the property"
},
"formal":{
"value":"Name of the property."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@type"
}
}
]
}
},
{
"path":{
"value":"SecurityEvent.object.detail.value"
},
"definition":{
"short":{
"value":"Property value"
},
"formal":{
"value":"Property value."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"base64Binary"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://nema.org/dicom"
},
"map":{
"value":"@value"
}
}
]
}
}
]
}
],
"binding":[
{
"name":{
"value":"SecurityEventObjectRole"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/object-role"
}
}
},
{
"name":{
"value":"SecurityEventObjectType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/object-type"
}
}
},
{
"name":{
"value":"SecurityEventAction"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-event-action"
}
}
},
{
"name":{
"value":"SecurityEventObjectLifecycle"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/object-lifecycle"
}
}
},
{
"name":{
"value":"SecurityEventSubType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-event-sub-type"
}
}
},
{
"name":{
"value":"SecurityEventSourceType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-source-type"
}
}
},
{
"name":{
"value":"SecurityEventParticipantNetworkType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/network-type"
}
}
},
{
"name":{
"value":"SecurityEventType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-event-type"
}
}
},
{
"name":{
"value":"DicomRoleId"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/dicm-402-roleid"
}
}
},
{
"name":{
"value":"SecurityEventOutcome"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-event-outcome"
}
}
},
{
"name":{
"value":"SecurityEventObjectSensitivity"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/security-event-sensitivity"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent\"><b>SecurityEvent<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifies the name, action type, time, and disposition of the audited event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event\"><b>event<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> What was done --><\/span>\r\n <<a title=\"Identifier for a family of the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-type.htm\">Type of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Identifier for the category of event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.subtype\"><b>subtype<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sub-type.htm\">Sub-type of event<\/a><\/span><span style=\"color: Gray\"> --><\/span></subtype>\r\n <<a title=\"Indicator for type of action performed during the event that generated the audit.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.action\"><b>action<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-action.htm\">Type of action performed during the event<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The time when the event occurred on the source.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.dateTime\"><b>dateTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#instant\">instant<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Time when the event occurred on source<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates whether the event succeeded or failed.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.outcome\"><b>outcome<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"security-event-outcome.htm\">Whether the event succeeded or failed<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A free text description of the outcome of the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.event.outcomeDesc\"><b>outcomeDesc<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the event outcome<\/span><span style=\"color: Gray\"> --><\/span>\r\n </event>\r\n <<a title=\"A person, a hardware device or software process.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant\"><b>participant<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..*<\/b><\/span> A person, a hardware device or software process --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.role\"><b>role<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-dicm-402-roleid.htm\">User roles (e.g. local RBAC codes)<\/a><\/span><span style=\"color: Gray\"> --><\/span></role>\r\n <<a title=\"Direct reference to a resource that identifies the participant.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Either an userId or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>|<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Direct reference to resource<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n <<a title=\"Unique identifier for the user actively participating in the event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.userId\"><b>userId<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-3: Either an userId or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Unique identifier for the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"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.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.authId\"><b>authId<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">User id used by authentication system<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Human-meaningful name for the user.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Human-meaningful name for the user<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicator that the user is or is not the requestor, or initiator, for the event being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.requestor\"><b>requestor<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#boolean\">boolean<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Whether user is initiator<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of media involved. Used when the event is about exporting/importing onto media.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.media\"><b>media<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\">Type of media<\/span><span style=\"color: Gray\"> --><\/span></media>\r\n <<a title=\"Logical network location for application activity, if the activity has a network location.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network\"><b>network<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1<\/b><\/span> Logical network location for application activity --><\/span>\r\n <<a title=\"An identifier for the network access point of the user device for the audit event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Identifier for the network access point of the user device<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"An identifier for the type of network access point that originated the audit event.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.participant.network.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"network-type.htm\">The type of network access point<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n </network>\r\n </participant>\r\n <<a title=\"Application systems and processes.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Application systems and processes --><\/span>\r\n <<a title=\"Logical source location within the healthcare enterprise network.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.site\"><b>site<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Logical source location within the enterprise<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifier of the source where the event originated.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.identifier\"><b>identifier<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">The id of source where event originated<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code specifying the type of source where event originated.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.source.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Coding\">Coding<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-source-type.htm\">The type of source where event originated<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n </source>\r\n <<a title=\"Specific instances of data or objects that have been accessed.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object\"><b>object<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specific instances of data or objects that have been accessed --><\/span>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Specific instance of object (e.g. versioned)<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Identifies a specific instance of the participant object. The reference should always be version specific.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.reference\"><b>reference<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-2: Either an identifier or a reference, but not both\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"resourcelist.htm\">Any<\/a>)<\/span> <span style=\"color: navy\">Specific instance of resource (e.g. versioned)<\/span><span style=\"color: Gray\"> --><\/span></reference>\r\n <<a title=\"Object type being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-type.htm\">Object type being audited<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Code representing the functional application role of Participant Object being audited.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.role\"><b>role<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-role.htm\">Functional application role of Object<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Identifier for the data life-cycle stage for the participant object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.lifecycle\"><b>lifecycle<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"object-lifecycle.htm\">Life-cycle stage for the object<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.sensitivity\"><b>sensitivity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-security-event-sensitivity.htm\">Policy-defined sensitivity for the object<\/a><\/span><span style=\"color: Gray\"> --><\/span></sensitivity>\r\n <<a title=\"An instance-specific descriptor of the Participant Object ID audited, such as a person's name.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Instance-specific descriptor for Object<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The actual query for a query-type participant object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.query\"><b>query<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span title=\"Inv-1: Either a name or a query (or both)\" style=\"color: deeppink\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Actual query for object<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Additional Information about the Object.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail\"><b>detail<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Additional Information about the Object --><\/span>\r\n <<a title=\"Name of the property.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail.type\"><b>type<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the property<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Property value.\" class=\"dict\" href=\"securityevent-definitions.htm#SecurityEvent.object.detail.value\"><b>value<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#base64Binary\">base64Binary<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Property value<\/span><span style=\"color: Gray\"> --><\/span>\r\n </detail>\r\n </object>\r\n</SecurityEvent>\r\n<\/pre><\/div>"
},
{
"title":"\"specimen\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/specimen",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/specimen.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"Sample for analysis.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen\"><b>Specimen<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Id for specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The type of the specimen. This is sometimes called the "matrix".\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-type.htm\">Type of specimen<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Parent specimen from which the focal specimen was a component.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Parent of specimen --><\/span>\r\n <<a title=\"Whether this relationship is to a parent or to a child.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source.relationship\"><b>relationship<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"hierarchical-relationship-type.htm\">parent | child<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The specimen resource that is the target of this relationship.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">The subject of the relationship<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </source>\r\n <<a title=\"The subject of the report.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">The subject of the report<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The identifier(s) assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.accessionIdentifier\"><b>accessionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Accession Identifier<\/span><span style=\"color: Gray\"> --><\/span></accessionIdentifier>\r\n <<a title=\"Time when specimen was received for processing or testing.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.receivedTime\"><b>receivedTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Received Time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details concerning the specimen collection.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection\"><b>collection<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Collection details --><\/span>\r\n <<a title=\"Person who collected the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.collector\"><b>collector<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the specimen<\/span><span style=\"color: Gray\"> --><\/span></collector>\r\n <<a title=\"To communicate any details or issues encountered during the specimen collection procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.comment\"><b>comment<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Collector comments<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Time when specimen was collected from subject - the physiologically relevant time.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.collectedTime\"><b>collectedTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Collection time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">The quantity of specimen collected<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"A coded value specifying the technique that is used to perform the procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-collection-type.htm\">Specimen Collection Method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"Anatomical location from which the specimen should be collected (if subject is a patient).\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.sourceSite\"><b>sourceSite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Site of the source of the specimen<\/a><\/span><span style=\"color: Gray\"> --><\/span></sourceSite>\r\n </collection>\r\n <<a title=\"Details concerning treatment and processing steps for the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment\"><b>treatment<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specimen Treatments --><\/span>\r\n <<a title=\"Textual description of procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Textual description of procedure<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A coded value specifying the procedure used to process the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.procedure\"><b>procedure<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-treatment-procedure.htm\">Specimen Treatment Procedure<\/a><\/span><span style=\"color: Gray\"> --><\/span></procedure>\r\n <<a title=\"Specimen additive.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.additive\"><b>additive<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Specimen additive<\/span><span style=\"color: Gray\"> --><\/span></additive>\r\n </treatment>\r\n <<a title=\"The container holding the specimen. May be recursive; ie blood in tube in tray in rack.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container\"><b>container<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specimen Container --><\/span>\r\n <<a title=\"Id for container. There may be muliple; a manufacturer's bar code, lab assigned identifier, etc.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id for container<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Textual description of container.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Textual description of container<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of container associated with the specimen (eg slide, aliquot, etc).\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-container-type.htm\">Specimen Container Type<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The capacity (volume or other measure the container may contain.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.capacity\"><b>capacity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Container Capacity<\/span><span style=\"color: Gray\"> --><\/span></capacity>\r\n <<a title=\"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.specimenQuantity\"><b>specimenQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Specimen Container Quantity<\/span><span style=\"color: Gray\"> --><\/span></specimenQuantity>\r\n <<a title=\"Additive associated with the container.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.additive\"><b>additive<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Container Additive<\/span><span style=\"color: Gray\"> --><\/span></additive>\r\n </container>\r\n</Specimen>\r\n<\/pre><\/div>"
},
"name":{
"value":"specimen"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. Sample for analysis."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Specimen"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Specimen"
},
"definition":{
"short":{
"value":"Sample for analysis"
},
"formal":{
"value":"Sample for analysis."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.identifier"
},
"definition":{
"short":{
"value":"External Identifier"
},
"formal":{
"value":"Id for specimen."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v2"
},
"map":{
"value":"SPM-2-specimen ID"
}
}
]
}
},
{
"path":{
"value":"Specimen.type"
},
"definition":{
"short":{
"value":"Type of specimen"
},
"formal":{
"value":"The type of the specimen. This is sometimes called the \"matrix\"."
},
"comments":{
"value":"The type can change the way that a spceimen 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":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SpecimenType"
}
}
},
{
"path":{
"value":"Specimen.source"
},
"definition":{
"short":{
"value":"Parent of specimen"
},
"formal":{
"value":"Parent specimen from which the focal specimen was a component."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.source.relationship"
},
"definition":{
"short":{
"value":"parent | child"
},
"formal":{
"value":"Whether this relationship is to a parent or to a child."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"HierarchicalRelationshipType"
}
}
},
{
"path":{
"value":"Specimen.source.target"
},
"definition":{
"short":{
"value":"The subject of the relationship"
},
"formal":{
"value":"The specimen resource that is the target of this relationship."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Specimen)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.subject"
},
"definition":{
"short":{
"value":"The subject of the report"
},
"formal":{
"value":"The subject of the report."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient|Group|Device|Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"unique(./participation[isHighest(priorityCode) and typeCode=\"SBJ\" and isNormalParticipation()]/role[classCode=\"PAT\"])"
}
}
]
}
},
{
"path":{
"value":"Specimen.accessionIdentifier"
},
"definition":{
"short":{
"value":"Accession Identifier"
},
"formal":{
"value":"The identifier(s) assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.receivedTime"
},
"definition":{
"short":{
"value":"Received Time"
},
"formal":{
"value":"Time when specimen was received for processing or testing."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection"
},
"definition":{
"short":{
"value":"Collection details"
},
"formal":{
"value":"Details concerning the specimen collection."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection.collector"
},
"definition":{
"short":{
"value":"Who collected the specimen"
},
"formal":{
"value":"Person who collected the specimen."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection.comment"
},
"definition":{
"short":{
"value":"Collector comments"
},
"formal":{
"value":"To communicate any details or issues encountered during the specimen collection procedure."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection.collectedTime"
},
"definition":{
"short":{
"value":"Collection time"
},
"formal":{
"value":"Time when specimen was collected from subject - the physiologically relevant time."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"dateTime"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection.quantity"
},
"definition":{
"short":{
"value":"The quantity of specimen collected"
},
"formal":{
"value":"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.collection.method"
},
"definition":{
"short":{
"value":"Specimen Collection Method"
},
"formal":{
"value":"A coded value specifying the technique that is used to perform the procedure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SpecimenCollectionMethod"
}
}
},
{
"path":{
"value":"Specimen.collection.sourceSite"
},
"definition":{
"short":{
"value":"Site of the source of the specimen"
},
"formal":{
"value":"Anatomical location from which the specimen should be collected (if subject is a patient)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"BodySite"
}
}
},
{
"path":{
"value":"Specimen.treatment"
},
"definition":{
"short":{
"value":"Specimen Treatments"
},
"formal":{
"value":"Details concerning treatment and processing steps for the specimen."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.treatment.description"
},
"definition":{
"short":{
"value":"Textual description of procedure"
},
"formal":{
"value":"Textual description of procedure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.treatment.procedure"
},
"definition":{
"short":{
"value":"Specimen Treatment Procedure"
},
"formal":{
"value":"A coded value specifying the procedure used to process the specimen."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SpecimenTreatmentProcedure"
}
}
},
{
"path":{
"value":"Specimen.treatment.additive"
},
"definition":{
"short":{
"value":"Specimen additive"
},
"formal":{
"value":"Specimen additive."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container"
},
"definition":{
"short":{
"value":"Specimen Container"
},
"formal":{
"value":"The container holding the specimen. May be recursive; ie blood in tube in tray in rack."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container.identifier"
},
"definition":{
"short":{
"value":"Id for container"
},
"formal":{
"value":"Id for container. There may be muliple; a manufacturer's bar code, lab assigned identifier, etc."
},
"min":{
"value":1
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container.description"
},
"definition":{
"short":{
"value":"Textual description of container"
},
"formal":{
"value":"Textual description of container."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container.type"
},
"definition":{
"short":{
"value":"Specimen Container Type"
},
"formal":{
"value":"The type of container associated with the specimen (eg slide, aliquot, etc)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SpecimenContainerType"
}
}
},
{
"path":{
"value":"Specimen.container.capacity"
},
"definition":{
"short":{
"value":"Container Capacity"
},
"formal":{
"value":"The capacity (volume or other measure the container may contain."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container.specimenQuantity"
},
"definition":{
"short":{
"value":"Specimen Container Quantity"
},
"formal":{
"value":"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Specimen.container.additive"
},
"definition":{
"short":{
"value":"Container Additive"
},
"formal":{
"value":"Additive associated with the container."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"BodySite"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/body-site"
}
}
},
{
"name":{
"value":"SpecimenCollectionMethod"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/specimen-collection-type"
}
}
},
{
"name":{
"value":"HierarchicalRelationshipType"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/hierarchical-relationship-type"
}
}
},
{
"name":{
"value":"SpecimenTreatmentProcedure"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/specimen-treatment-procedure"
}
}
},
{
"name":{
"value":"SpecimenContainerType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"example"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/specimen-container-type"
}
}
},
{
"name":{
"value":"SpecimenType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/specimen-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"Sample for analysis.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen\"><b>Specimen<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Id for specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External Identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"The type of the specimen. This is sometimes called the "matrix".\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-type.htm\">Type of specimen<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Parent specimen from which the focal specimen was a component.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source\"><b>source<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Parent of specimen --><\/span>\r\n <<a title=\"Whether this relationship is to a parent or to a child.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source.relationship\"><b>relationship<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"hierarchical-relationship-type.htm\">parent | child<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The specimen resource that is the target of this relationship.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.source.target\"><b>target<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"specimen.htm#Specimen\">Specimen<\/a>)<\/span> <span style=\"color: navy\">The subject of the relationship<\/span><span style=\"color: Gray\"> --><\/span></target>\r\n </source>\r\n <<a title=\"The subject of the report.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.subject\"><b>subject<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>|<a href=\"group.htm#Group\">Group<\/a>|<a href=\"device.htm#Device\">Device<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">The subject of the report<\/span><span style=\"color: Gray\"> --><\/span></subject>\r\n <<a title=\"The identifier(s) assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.accessionIdentifier\"><b>accessionIdentifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Accession Identifier<\/span><span style=\"color: Gray\"> --><\/span></accessionIdentifier>\r\n <<a title=\"Time when specimen was received for processing or testing.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.receivedTime\"><b>receivedTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Received Time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Details concerning the specimen collection.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection\"><b>collection<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>1..1<\/b><\/span> Collection details --><\/span>\r\n <<a title=\"Person who collected the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.collector\"><b>collector<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the specimen<\/span><span style=\"color: Gray\"> --><\/span></collector>\r\n <<a title=\"To communicate any details or issues encountered during the specimen collection procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.comment\"><b>comment<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: navy\">Collector comments<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Time when specimen was collected from subject - the physiologically relevant time.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.collectedTime\"><b>collectedTime<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#dateTime\">dateTime<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Collection time<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">The quantity of specimen collected<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"A coded value specifying the technique that is used to perform the procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.method\"><b>method<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-collection-type.htm\">Specimen Collection Method<\/a><\/span><span style=\"color: Gray\"> --><\/span></method>\r\n <<a title=\"Anatomical location from which the specimen should be collected (if subject is a patient).\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.collection.sourceSite\"><b>sourceSite<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-body-site.htm\">Site of the source of the specimen<\/a><\/span><span style=\"color: Gray\"> --><\/span></sourceSite>\r\n </collection>\r\n <<a title=\"Details concerning treatment and processing steps for the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment\"><b>treatment<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specimen Treatments --><\/span>\r\n <<a title=\"Textual description of procedure.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Textual description of procedure<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"A coded value specifying the procedure used to process the specimen.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.procedure\"><b>procedure<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-treatment-procedure.htm\">Specimen Treatment Procedure<\/a><\/span><span style=\"color: Gray\"> --><\/span></procedure>\r\n <<a title=\"Specimen additive.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.treatment.additive\"><b>additive<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Specimen additive<\/span><span style=\"color: Gray\"> --><\/span></additive>\r\n </treatment>\r\n <<a title=\"The container holding the specimen. May be recursive; ie blood in tube in tray in rack.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container\"><b>container<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Specimen Container --><\/span>\r\n <<a title=\"Id for container. There may be muliple; a manufacturer's bar code, lab assigned identifier, etc.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Id for container<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Textual description of container.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Textual description of container<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The type of container associated with the specimen (eg slide, aliquot, etc).\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-specimen-container-type.htm\">Specimen Container Type<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The capacity (volume or other measure the container may contain.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.capacity\"><b>capacity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Container Capacity<\/span><span style=\"color: Gray\"> --><\/span></capacity>\r\n <<a title=\"The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.specimenQuantity\"><b>specimenQuantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Specimen Container Quantity<\/span><span style=\"color: Gray\"> --><\/span></specimenQuantity>\r\n <<a title=\"Additive associated with the container.\" class=\"dict\" href=\"specimen-definitions.htm#Specimen.container.additive\"><b>additive<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Container Additive<\/span><span style=\"color: Gray\"> --><\/span></additive>\r\n </container>\r\n</Specimen>\r\n<\/pre><\/div>"
},
{
"title":"\"substance\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/substance",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/substance.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A homogeneous material with a definite composition used in healthcare.\" class=\"dict\" href=\"substance-definitions.htm#Substance\"><b>Substance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier of the substance<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Name of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the substance<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-type.htm\">Type of the substance<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Description of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the substance<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Substance status.\" class=\"dict\" href=\"substance-definitions.htm#Substance.status\"><b>status<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-status.htm\">Substance status<\/a><\/span><span style=\"color: Gray\"> --><\/span></status>\r\n <<a title=\"When the substance is active or effective.\" class=\"dict\" href=\"substance-definitions.htm#Substance.effectiveTime\"><b>effectiveTime<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Substance effective period<\/span><span style=\"color: Gray\"> --><\/span></effectiveTime>\r\n <<a title=\"The amount of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Substance amount<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"A substance can be composed of other substances.\" class=\"dict\" href=\"substance-definitions.htm#Substance.ingredient\"><b>ingredient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Substance composition<\/span><span style=\"color: Gray\"> --><\/span></ingredient>\r\n <<a title=\"Indicates whether the substance quantity (used for ingredients) are absolute values or values relative to each other (percentages).\" class=\"dict\" href=\"substance-definitions.htm#Substance.quantityMode\"><b>quantityMode<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-mode.htm\">Absolute | Relative<\/a><\/span><span style=\"color: Gray\"> --><\/span></quantityMode>\r\n</Substance>\r\n<\/pre><\/div>"
},
"name":{
"value":"substance"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A homogeneous material with a definite composition used in healthcare."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Substance"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Substance"
},
"definition":{
"short":{
"value":"A homogeneous material with a definite composition used in healthcare"
},
"formal":{
"value":"A homogeneous material with a definite composition used in healthcare."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.identifier"
},
"definition":{
"short":{
"value":"Identifier of the substance"
},
"formal":{
"value":"Identifier of the substance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.name"
},
"definition":{
"short":{
"value":"Name of the substance"
},
"formal":{
"value":"Name of the substance."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.type"
},
"definition":{
"short":{
"value":"Type of the substance"
},
"formal":{
"value":"Type of the substance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SubstanceType"
}
}
},
{
"path":{
"value":"Substance.description"
},
"definition":{
"short":{
"value":"Description of the substance"
},
"formal":{
"value":"Description of the substance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"string"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.status"
},
"definition":{
"short":{
"value":"Substance status"
},
"formal":{
"value":"Substance status."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SubstanceStatus"
}
}
},
{
"path":{
"value":"Substance.effectiveTime"
},
"definition":{
"short":{
"value":"Substance effective period"
},
"formal":{
"value":"When the substance is active or effective."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.quantity"
},
"definition":{
"short":{
"value":"Substance amount"
},
"formal":{
"value":"The amount of the substance."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.ingredient"
},
"definition":{
"short":{
"value":"Substance composition"
},
"formal":{
"value":"A substance can be composed of other substances."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Substance)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Substance.quantityMode"
},
"definition":{
"short":{
"value":"Absolute | Relative"
},
"formal":{
"value":"Indicates whether the substance quantity (used for ingredients) are absolute values or values relative to each other (percentages)."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SubstanceQuantityMode"
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"SubstanceQuantityMode"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/substance-mode"
}
}
},
{
"name":{
"value":"SubstanceStatus"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/substance-status"
}
}
},
{
"name":{
"value":"SubstanceType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/substance-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A homogeneous material with a definite composition used in healthcare.\" class=\"dict\" href=\"substance-definitions.htm#Substance\"><b>Substance<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Identifier of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Identifier of the substance<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Name of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.name\"><b>name<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>1..1<\/b><\/span> <span style=\"color: navy\">Name of the substance<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Type of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-type.htm\">Type of the substance<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"Description of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.description\"><b>description<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#string\">string<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\">Description of the substance<\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Substance status.\" class=\"dict\" href=\"substance-definitions.htm#Substance.status\"><b>status<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-status.htm\">Substance status<\/a><\/span><span style=\"color: Gray\"> --><\/span></status>\r\n <<a title=\"When the substance is active or effective.\" class=\"dict\" href=\"substance-definitions.htm#Substance.effectiveTime\"><b>effectiveTime<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Substance effective period<\/span><span style=\"color: Gray\"> --><\/span></effectiveTime>\r\n <<a title=\"The amount of the substance.\" class=\"dict\" href=\"substance-definitions.htm#Substance.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Substance amount<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"A substance can be composed of other substances.\" class=\"dict\" href=\"substance-definitions.htm#Substance.ingredient\"><b>ingredient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"substance.htm#Substance\">Substance<\/a>)<\/span> <span style=\"color: navy\">Substance composition<\/span><span style=\"color: Gray\"> --><\/span></ingredient>\r\n <<a title=\"Indicates whether the substance quantity (used for ingredients) are absolute values or values relative to each other (percentages).\" class=\"dict\" href=\"substance-definitions.htm#Substance.quantityMode\"><b>quantityMode<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-substance-mode.htm\">Absolute | Relative<\/a><\/span><span style=\"color: Gray\"> --><\/span></quantityMode>\r\n</Substance>\r\n<\/pre><\/div>"
},
{
"title":"\"supply\" as a profile (to help derivation)",
"id":"http://hl7.org/fhir/profile/supply",
"link":[
{
"rel":"self",
"href":"http://hl7.org/implement/standards/fhir/supply.profile.xml"
}
],
"updated":"2014-01-31T20:45:10.480+11:00",
"published":"2014-01-31T20:45:10.480+11:00",
"author":[
{
"name":"HL7, Inc (FHIR Project)",
"uri":"http://hl7.org/fhir"
}
],
"content":{
"Profile":{
"text":{
"status":{
"value":"generated"
},
"div":"<div><pre>\r\n<<a title=\"A supply - request and provision.\" class=\"dict\" href=\"supply-definitions.htm#Supply\"><b>Supply<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Category of supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-type.htm\">The kind of supply (central, non-stock, etc)<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Unique identifier for this kind of supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Unique identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Status of the supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.htm\">Dispensed|Received|Requested<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The item which was ordered.\" class=\"dict\" href=\"supply-definitions.htm#Supply.orderedItem\"><b>orderedItem<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Medication, Substance, or Device requested to be supplied<\/span><span style=\"color: Gray\"> --><\/span></orderedItem>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"supply-definitions.htm#Supply.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supply details --><\/span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.htm\">Active/Completed/Aborted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-item.htm\">Type of dispense<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The amount of supply that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount dispensed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.suppliedItem\"><b>suppliedItem<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Medication, Substance, or Device being supplied<\/span><span style=\"color: Gray\"> --><\/span></suppliedItem>\r\n <<a title=\"The individual reponsible for dispensing the medication.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.supplier\"><b>supplier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Dispenser<\/span><span style=\"color: Gray\"> --><\/span></supplier>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.whenPrepared\"><b>whenPrepared<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Dispensing time<\/span><span style=\"color: Gray\"> --><\/span></whenPrepared>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.whenHandedOver\"><b>whenHandedOver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Handover time<\/span><span style=\"color: Gray\"> --><\/span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the Supply was shipped to, as part of the dispense event.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the Supply was sent<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Identifies the person who picked up the Supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the Supply<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n </dispense>\r\n</Supply>\r\n<\/pre><\/div>"
},
"name":{
"value":"supply"
},
"publisher":{
"value":"FHIR Project"
},
"description":{
"value":"Basic Profile. A supply - request and provision."
},
"status":{
"value":"draft"
},
"date":{
"value":"2014-01-31"
},
"structure":[
{
"type":{
"value":"Supply"
},
"publish":{
"value":true
},
"element":[
{
"path":{
"value":"Supply"
},
"definition":{
"short":{
"value":"A supply - request and provision"
},
"formal":{
"value":"A supply - request and provision."
},
"min":{
"value":1
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.extension"
},
"definition":{
"short":{
"value":"Additional Content defined by implementations"
},
"formal":{
"value":"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 governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that must be met as part of the definition of the extension."
},
"comments":{
"value":"there can be no stigma\nassociated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."
},
"synonym":[
{
"value":"extensions"
},
{
"value":"user content"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Extension"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.text"
},
"definition":{
"short":{
"value":"Text summary of the resource, for human interpretation"
},
"formal":{
"value":"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":{
"value":"Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
},
"synonym":[
{
"value":"narrative"
},
{
"value":"html"
},
{
"value":"xhtml"
},
{
"value":"display"
}
],
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Narrative"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.contained"
},
"definition":{
"short":{
"value":"Contained, inline Resources"
},
"formal":{
"value":"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":{
"value":"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."
},
"synonym":[
{
"value":"inline resources"
},
{
"value":"anonymous resources"
},
{
"value":"contained resources"
}
],
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource"
}
}
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.name"
},
"definition":{
"short":{
"value":"The kind of supply (central, non-stock, etc)"
},
"formal":{
"value":"Category of supply."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SupplyType"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./code"
}
}
]
}
},
{
"path":{
"value":"Supply.identifier"
},
"definition":{
"short":{
"value":"Unique identifier"
},
"formal":{
"value":"Unique identifier for this kind of supply."
},
"comments":{
"value":"This is assigned by the orderer, and used to refer to this order in other external standards."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.status"
},
"definition":{
"short":{
"value":"Dispensed|Received|Requested"
},
"formal":{
"value":"Status of the supply."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SupplyStatus"
},
"mapping":[
{
"target":{
"value":"http://hl7.org/v3"
},
"map":{
"value":"./statusCode"
}
}
]
}
},
{
"path":{
"value":"Supply.orderedItem"
},
"definition":{
"short":{
"value":"Medication, Substance, or Device requested to be supplied"
},
"formal":{
"value":"The item which was ordered."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication|Substance|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.patient"
},
"definition":{
"short":{
"value":"Patient"
},
"formal":{
"value":"A link to a resource representing the person to whom the medication will be given."
},
"comments":{
"value":"SubstanceAdministration->subject->Patient."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Patient)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense"
},
"definition":{
"short":{
"value":"Supply details"
},
"formal":{
"value":"Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.identifier"
},
"definition":{
"short":{
"value":"External identifier"
},
"formal":{
"value":"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Identifier"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.status"
},
"definition":{
"short":{
"value":"Active/Completed/Aborted"
},
"formal":{
"value":"A code specifying the state of the dispense event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"code"
}
}
],
"condition":[
],
"isModifier":{
"value":true
},
"binding":{
"value":"SupplyStatus"
}
}
},
{
"path":{
"value":"Supply.dispense.type"
},
"definition":{
"short":{
"value":"Type of dispense"
},
"formal":{
"value":"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"CodeableConcept"
}
}
],
"condition":[
],
"isModifier":{
"value":false
},
"binding":{
"value":"SupplyItemType"
}
}
},
{
"path":{
"value":"Supply.dispense.quantity"
},
"definition":{
"short":{
"value":"Amount dispensed"
},
"formal":{
"value":"The amount of supply that has been dispensed. Includes unit of measure."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Quantity"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.suppliedItem"
},
"definition":{
"short":{
"value":"Medication, Substance, or Device being supplied"
},
"formal":{
"value":"Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Medication|Substance|Device)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.supplier"
},
"definition":{
"short":{
"value":"Dispenser"
},
"formal":{
"value":"The individual reponsible for dispensing the medication."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.whenPrepared"
},
"definition":{
"short":{
"value":"Dispensing time"
},
"formal":{
"value":"The time the dispense event occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.whenHandedOver"
},
"definition":{
"short":{
"value":"Handover time"
},
"formal":{
"value":"The time the dispense event occurred."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Period"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.destination"
},
"definition":{
"short":{
"value":"Where the Supply was sent"
},
"formal":{
"value":"Identification of the facility/location where the Supply was shipped to, as part of the dispense event."
},
"min":{
"value":0
},
"max":{
"value":"1"
},
"type":[
{
"code":{
"value":"Resource(Location)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
},
{
"path":{
"value":"Supply.dispense.receiver"
},
"definition":{
"short":{
"value":"Who collected the Supply"
},
"formal":{
"value":"Identifies the person who picked up the Supply."
},
"min":{
"value":0
},
"max":{
"value":"*"
},
"type":[
{
"code":{
"value":"Resource(Practitioner)"
}
}
],
"condition":[
],
"isModifier":{
"value":false
}
}
}
]
}
],
"binding":[
{
"name":{
"value":"SupplyItemType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/supply-item"
}
}
},
{
"name":{
"value":"SupplyStatus"
},
"conformance":{
"value":"required"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/supply-status"
}
}
},
{
"name":{
"value":"SupplyType"
},
"isExtensible":{
"value":true
},
"conformance":{
"value":"preferred"
},
"referenceResource":{
"type":{
"value":"ValueSet"
},
"reference":{
"value":"http://hl7.org/fhir/vs/supply-type"
}
}
}
]
}
},
"summary":"<div><pre>\r\n<<a title=\"A supply - request and provision.\" class=\"dict\" href=\"supply-definitions.htm#Supply\"><b>Supply<\/b><\/a> xmlns="http://hl7.org/fhir">\r\n <!-- from <a href=\"resources.htm\">Resource<\/a>: <a href=\"extensibility.htm\">extension<\/a>, <a href=\"narrative.htm#Narrative\">narrative<\/a>, and <a href=\"references.htm#contained\">contained<\/a> -->\r\n <<a title=\"Category of supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.name\"><b>name<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-type.htm\">The kind of supply (central, non-stock, etc)<\/a><\/span><span style=\"color: Gray\"> --><\/span></name>\r\n <<a title=\"Unique identifier for this kind of supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">Unique identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"Status of the supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.status\"><b>status<\/b><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.htm\">Dispensed|Received|Requested<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"The item which was ordered.\" class=\"dict\" href=\"supply-definitions.htm#Supply.orderedItem\"><b>orderedItem<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Medication, Substance, or Device requested to be supplied<\/span><span style=\"color: Gray\"> --><\/span></orderedItem>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"supply-definitions.htm#Supply.patient\"><b>patient<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"patient.htm#Patient\">Patient<\/a>)<\/span> <span style=\"color: navy\">Patient<\/span><span style=\"color: Gray\"> --><\/span></patient>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of a supply dispensed.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense\"><b>dispense<\/b><\/a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*<\/b><\/span> Supply details --><\/span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.identifier\"><b>identifier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Identifier\">Identifier<\/a><\/span> <span style=\"color: navy\">External identifier<\/span><span style=\"color: Gray\"> --><\/span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.status\"><span style=\"text-decoration: underline\"><b>status<\/b><\/span><\/a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.htm#code\">code<\/a><\/span>]"/><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-status.htm\">Active/Completed/Aborted<\/a><\/span><span style=\"color: Gray\"> --><\/span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.type\"><b>type<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#CodeableConcept\">CodeableConcept<\/a><\/span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-supply-item.htm\">Type of dispense<\/a><\/span><span style=\"color: Gray\"> --><\/span></type>\r\n <<a title=\"The amount of supply that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.quantity\"><b>quantity<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Quantity\">Quantity<\/a><\/span> <span style=\"color: navy\">Amount dispensed<\/span><span style=\"color: Gray\"> --><\/span></quantity>\r\n <<a title=\"Identifies the medication or substance being dispensed. This is either a link to a resource representing the details of the medication or substance or a simple attribute carrying a code that identifies the medication from a known list of medications.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.suppliedItem\"><b>suppliedItem<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"medication.htm#Medication\">Medication<\/a>|<a href=\"substance.htm#Substance\">Substance<\/a>|<a href=\"device.htm#Device\">Device<\/a>)<\/span> <span style=\"color: navy\">Medication, Substance, or Device being supplied<\/span><span style=\"color: Gray\"> --><\/span></suppliedItem>\r\n <<a title=\"The individual reponsible for dispensing the medication.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.supplier\"><b>supplier<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Dispenser<\/span><span style=\"color: Gray\"> --><\/span></supplier>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.whenPrepared\"><b>whenPrepared<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Dispensing time<\/span><span style=\"color: Gray\"> --><\/span></whenPrepared>\r\n <<a title=\"The time the dispense event occurred.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.whenHandedOver\"><b>whenHandedOver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"datatypes.htm#Period\">Period<\/a><\/span> <span style=\"color: navy\">Handover time<\/span><span style=\"color: Gray\"> --><\/span></whenHandedOver>\r\n <<a title=\"Identification of the facility/location where the Supply was shipped to, as part of the dispense event.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.destination\"><b>destination<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..1<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"location.htm#Location\">Location<\/a>)<\/span> <span style=\"color: navy\">Where the Supply was sent<\/span><span style=\"color: Gray\"> --><\/span></destination>\r\n <<a title=\"Identifies the person who picked up the Supply.\" class=\"dict\" href=\"supply-definitions.htm#Supply.dispense.receiver\"><b>receiver<\/b><\/a>><span style=\"color: Gray\"><!--<\/span> <span style=\"color: brown\"><b>0..*<\/b><\/span> <span style=\"color: darkgreen\"><a href=\"references.htm#Resource\">Resource<\/a>(<a href=\"practitioner.htm#Practitioner\">Practitioner<\/a>)<\/span> <span style=\"color: navy\">Who collected the Supply<\/span><span style=\"color: Gray\"> --><\/span></receiver>\r\n </dispense>\r\n</Supply>\r\n<\/pre><\/div>"
}
]
}
}