# structure_cache

package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: Practitioner
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-practitioner", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner", "version": "1.1.0-preview", "name": "AUCorePractitioner", "title": "AU Core Practitioner", "status": "active", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile sets minimum expectations for a Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It is based on the [AU Base Practitioner](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-practitioner.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Practitioner when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping"}, {"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}, {"identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD"}, {"identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping"}], "kind": "resource", "abstract": false, "type": "Practitioner", "baseDefinition": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.1.0-preview"}], "element": [{"id": "Practitioner", "path": "Practitioner", "short": "A person with a formal responsibility in the provisioning of services", "definition": "A person who is directly or indirectly involved in the provisioning of healthcare.", "min": 0, "max": "*", "base": {"path": "Practitioner", "min": 0, "max": "*"}, "constraint": [{"key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "inv-pra-0", "severity": "warning", "human": "Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner"}, {"key": "inv-pra-1", "severity": "warning", "human": "Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner"}, {"key": "inv-pra-2", "severity": "warning", "human": "Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner"}, {"key": "inv-pra-3", "severity": "warning", "human": "Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner"}, {"key": "inv-pra-4", "severity": "warning", "human": "Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Entity. Role, or Act"}, {"identity": "v2", "map": "PRD (as one example)"}, {"identity": "rim", "map": "Role"}, {"identity": "servd", "map": "Provider"}]}, {"id": "Practitioner.id", "path": "Practitioner.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": {"path": "Resource.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": true}, {"id": "Practitioner.meta", "path": "Practitioner.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": {"path": "Resource.meta", "min": 0, "max": "1"}, "type": [{"code": "Meta"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true}, {"id": "Practitioner.implicitRules", "path": "Practitioner.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": {"path": "Resource.implicitRules", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true}, {"id": "Practitioner.language", "path": "Practitioner.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": {"path": "Resource.language", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language"}], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages"}}, {"id": "Practitioner.text", "path": "Practitioner.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": ["narrative", "html", "xhtml", "display"], "min": 0, "max": "1", "base": {"path": "DomainResource.text", "min": 0, "max": "1"}, "type": [{"code": "Narrative"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Act.text?"}]}, {"id": "Practitioner.contained", "path": "Practitioner.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": ["inline resources", "anonymous resources", "contained resources"], "min": 0, "max": "*", "base": {"path": "DomainResource.contained", "min": 0, "max": "*"}, "type": [{"code": "Resource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Practitioner.extension", "path": "Practitioner.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Practitioner.extension:genderIdentity", "path": "Practitioner.extension", "sliceName": "genderIdentity", "short": "Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply", "definition": "An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.", "comment": "The individual's gender identity is populated in the `extension:value.value[x]` of the [Individual Gender Identity](http://hl7.org/fhir/StructureDefinition/individual-genderIdentity) extension and shall contain one of the codes from the [Gender Identity Response](https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1) value set if any of the codes within the value set can apply.\n\nSee [Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020](https://www.abs.gov.au/statistics/standards/standard-sex-gender-variations-sex-characteristics-and-sexual-orientation-variables/latest-release#gender) for further materials.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"]}], "condition": ["inv-pra-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "Practitioner.extension:individualPronouns", "path": "Practitioner.extension", "sliceName": "individualPronouns", "short": "Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply", "definition": "The pronouns to use when referring to an individual in verbal or written communication.", "comment": "The individual's pronouns are populated in the `extension:value.value[x]` of the [Individual Pronouns](http://hl7.org/fhir/StructureDefinition/individual-pronouns) extension and shall contain one of the codes from the [Australian Pronouns](https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1) value set if any of the codes within the value set can apply.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-pronouns"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "Practitioner.extension:recordedSexOrGender", "path": "Practitioner.extension", "sliceName": "recordedSexOrGender", "short": "Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply", "definition": "A sex or gender property for the individual from a document or other record", "comment": "The type of recorded sex or gender is populated in the `extension:type.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender Type](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-rsg-type.html) value set if any of the codes within the value set can apply.\n\nThe document from which the sex or gender property was acquired is populated in the `extension:sourceDocument.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender (RSG) Source Document Type](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-rsg-source-document-type.html) value set if any of the codes within the value set can apply.\n\nThe jurisdiction that issued the document where the sex or gender was acquired is populated in the `extension:jurisdiction.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [Jurisdiction ValueSet - AU Extended](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-au-jurisdiction-extended.html) value set if any of the codes within the value set can apply.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"]}], "condition": ["inv-pra-2", "inv-pra-3", "inv-pra-4"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "Practitioner.modifierExtension", "path": "Practitioner.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Practitioner.identifier", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.identifier", "slicing": {"discriminator": [{"type": "pattern", "path": "type"}], "rules": "open"}, "short": "An identifier for the person as this agent", "definition": "An identifier that applies to this person in this role.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "*", "base": {"path": "Practitioner.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier", "profile": ["http://hl7.org/fhir/StructureDefinition/Identifier", "http://hl7.org.au/fhir/StructureDefinition/au-hpii", "http://hl7.org.au/fhir/StructureDefinition/au-pbsprescribernumber", "http://hl7.org.au/fhir/StructureDefinition/au-careagencyemployeeidentifier", "http://hl7.org.au/fhir/StructureDefinition/au-ahpraregistrationnumber"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "PRD-7 (or XCN.1)"}, {"identity": "rim", "map": "./id"}, {"identity": "servd", "map": "./Identifiers"}]}, {"id": "Practitioner.identifier:hpii", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.identifier", "sliceName": "hpii", "short": "An identifier for the person as this agent", "definition": "An identifier that applies to this person in this role.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "1", "base": {"path": "Practitioner.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-hpii"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "PRD-7 (or XCN.1)"}, {"identity": "rim", "map": "./id"}, {"identity": "servd", "map": "./Identifiers"}]}, {"id": "Practitioner.active", "path": "Practitioner.active", "short": "Whether this practitioner's record is in active use", "definition": "Whether this practitioner's record is in active use.", "comment": "If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.", "requirements": "Need to be able to mark a practitioner record as not to be used because it was created in error.", "min": 0, "max": "1", "base": {"path": "Practitioner.active", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.status"}, {"identity": "rim", "map": "./statusCode"}]}, {"id": "Practitioner.name", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name", "short": "The name(s) associated with the practitioner", "definition": "The name(s) associated with the practitioner.", "comment": "The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.  \r\rIn general, select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.", "requirements": "The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.", "min": 1, "max": "*", "base": {"path": "Practitioner.name", "min": 0, "max": "*"}, "type": [{"code": "HumanName"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XCN Components"}, {"identity": "rim", "map": "./name"}, {"identity": "servd", "map": "./PreferredName (GivenNames, FamilyName, TitleCode)"}]}, {"id": "Practitioner.name.id", "path": "Practitioner.name.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Practitioner.name.extension", "path": "Practitioner.name.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Practitioner.name.use", "path": "Practitioner.name.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "base": {"path": "HumanName.use", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse"}], "strength": "required", "description": "The use of a human name.", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1"}, "mapping": [{"identity": "v2", "map": "XPN.7, but often indicated by which field contains the name"}, {"identity": "rim", "map": "unique(./use)"}, {"identity": "servd", "map": "./NamePurpose"}]}, {"id": "Practitioner.name.text", "path": "Practitioner.name.text", "short": "Text representation of the full name", "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present,  no content is included in the text that isn't found in a part.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": {"path": "HumanName.text", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "implied by XPN.11"}, {"identity": "rim", "map": "./formatted"}]}, {"id": "Practitioner.name.family", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "alias": ["surname"], "min": 1, "max": "1", "base": {"path": "HumanName.family", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.1/FN.1"}, {"identity": "rim", "map": "./part[partType = FAM]"}, {"identity": "servd", "map": "./FamilyName"}]}, {"id": "Practitioner.name.given", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given name.", "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations.  This element is not called \"first name\" since given names do not always come first.", "alias": ["first name", "middle name"], "min": 0, "max": "*", "base": {"path": "HumanName.given", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Given Names appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.2 + XPN.3"}, {"identity": "rim", "map": "./part[partType = GIV]"}, {"identity": "servd", "map": "./GivenNames"}]}, {"id": "Practitioner.name.prefix", "path": "Practitioner.name.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "*", "base": {"path": "HumanName.prefix", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Prefixes appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.5"}, {"identity": "rim", "map": "./part[partType = PFX]"}, {"identity": "servd", "map": "./TitleCode"}]}, {"id": "Practitioner.name.suffix", "path": "Practitioner.name.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "*", "base": {"path": "HumanName.suffix", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Suffixes appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN/4"}, {"identity": "rim", "map": "./part[partType = SFX]"}]}, {"id": "Practitioner.name.period", "path": "Practitioner.name.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "base": {"path": "HumanName.period", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.13 + XPN.14"}, {"identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]"}, {"identity": "servd", "map": "./StartDate and ./EndDate"}]}, {"id": "Practitioner.telecom", "path": "Practitioner.telecom", "short": "A contact detail for the practitioner (that apply to all roles)", "definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.", "comment": "Person may have multiple ways to be contacted with different uses or applicable periods.  May need to have options for contacting the person urgently and to help with identification.  These typically will have home numbers, or mobile numbers that are not role specific.", "requirements": "Need to know how to reach a practitioner independent to any roles the practitioner may have.", "min": 0, "max": "*", "base": {"path": "Practitioner.telecom", "min": 0, "max": "*"}, "type": [{"code": "ContactPoint"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "PRT-15, STF-10, ROL-12"}, {"identity": "rim", "map": "./telecom"}, {"identity": "servd", "map": "./ContactPoints"}]}, {"id": "Practitioner.address", "path": "Practitioner.address", "short": "Address(es) of the practitioner that are not role specific (typically home address)", "definition": "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.", "comment": "The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).", "requirements": "The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.", "min": 0, "max": "*", "base": {"path": "Practitioner.address", "min": 0, "max": "*"}, "type": [{"code": "Address", "profile": ["http://hl7.org/fhir/StructureDefinition/Address", "http://hl7.org.au/fhir/StructureDefinition/au-address"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "ORC-24, STF-11, ROL-11, PRT-14"}, {"identity": "rim", "map": "./addr"}, {"identity": "servd", "map": "./Addresses"}]}, {"id": "Practitioner.gender", "path": "Practitioner.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "requirements": "Needed to address the person correctly.", "min": 0, "max": "1", "base": {"path": "Practitioner.gender", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender"}], "strength": "required", "description": "The gender of a person used for administrative purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"}, "mapping": [{"identity": "v2", "map": "STF-5"}, {"identity": "rim", "map": "./administrativeGender"}, {"identity": "servd", "map": "./GenderCode"}]}, {"id": "Practitioner.birthDate", "path": "Practitioner.birthDate", "short": "The date  on which the practitioner was born", "definition": "The date of birth for the practitioner.", "requirements": "Needed for identification.", "min": 0, "max": "1", "base": {"path": "Practitioner.birthDate", "min": 0, "max": "1"}, "type": [{"code": "date"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "STF-6"}, {"identity": "rim", "map": "./birthTime"}, {"identity": "servd", "map": "(not represented in ServD)"}]}, {"id": "Practitioner.photo", "path": "Practitioner.photo", "short": "Image of the person", "definition": "Image of the person.", "requirements": "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.", "min": 0, "max": "*", "base": {"path": "Practitioner.photo", "min": 0, "max": "*"}, "type": [{"code": "Attachment"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"}, {"identity": "servd", "map": "./ImageURI (only supports the URI reference)"}]}, {"id": "Practitioner.qualification", "path": "Practitioner.qualification", "short": "Certification, licenses, or training pertaining to the provision of care", "definition": "The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner.  For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.", "min": 0, "max": "*", "base": {"path": "Practitioner.qualification", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "CER?"}, {"identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code"}, {"identity": "servd", "map": "./Qualifications"}]}, {"id": "Practitioner.qualification.id", "path": "Practitioner.qualification.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Practitioner.qualification.extension", "path": "Practitioner.qualification.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Practitioner.qualification.modifierExtension", "path": "Practitioner.qualification.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Practitioner.qualification.identifier", "path": "Practitioner.qualification.identifier", "short": "An identifier for this qualification for the practitioner", "definition": "An identifier that applies to this person's qualification in this role.", "requirements": "Often, specific identities are assigned for the qualification.", "min": 0, "max": "*", "base": {"path": "Practitioner.qualification.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].id"}]}, {"id": "Practitioner.qualification.code", "path": "Practitioner.qualification.code", "short": "Coded representation of the qualification", "definition": "Coded representation of the qualification.", "min": 1, "max": "1", "base": {"path": "Practitioner.qualification.code", "min": 1, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"strength": "preferred", "valueSet": "http://terminology.hl7.org.au/ValueSet/v2-0360-extended"}, "mapping": [{"identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].code"}, {"identity": "servd", "map": "./Qualifications.Value"}]}, {"id": "Practitioner.qualification.period", "path": "Practitioner.qualification.period", "short": "Period during which the qualification is valid", "definition": "Period during which the qualification is valid.", "requirements": "Qualifications are often for a limited period of time, and can be revoked.", "min": 0, "max": "1", "base": {"path": "Practitioner.qualification.period", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].effectiveTime"}, {"identity": "servd", "map": "./Qualifications.StartDate and ./Qualifications.EndDate"}]}, {"id": "Practitioner.qualification.issuer", "path": "Practitioner.qualification.issuer", "short": "Organization that regulates and issues the qualification", "definition": "Organization that regulates and issues the qualification.", "min": 0, "max": "1", "base": {"path": "Practitioner.qualification.issuer", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".playingEntity.playingRole[classCode=QUAL].scoper"}]}, {"id": "Practitioner.communication", "path": "Practitioner.communication", "short": "A language the practitioner can use in patient communication", "definition": "A language the practitioner can use in patient communication.", "comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.", "requirements": "Knowing which language a practitioner speaks can help in facilitating communication with patients.", "min": 0, "max": "*", "base": {"path": "Practitioner.communication", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2"}, "mapping": [{"identity": "v2", "map": "PID-15, NK1-20, LAN-2"}, {"identity": "rim", "map": "./languageCommunication"}, {"identity": "servd", "map": "./Languages.LanguageSpokenCode"}]}]}, "differential": {"element": [{"id": "Practitioner", "path": "Practitioner", "short": "A person with a formal responsibility in the provisioning of services"}, {"id": "Practitioner.identifier", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.identifier", "slicing": {"discriminator": [{"type": "pattern", "path": "type"}], "rules": "open"}, "definition": "An identifier that applies to this person in this role.", "mustSupport": true}, {"id": "Practitioner.identifier:hpii", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.identifier", "sliceName": "hpii", "max": "1", "type": [{"code": "Identifier", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-hpii"]}], "mustSupport": true}, {"id": "Practitioner.name", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name", "min": 1, "mustSupport": true}, {"id": "Practitioner.name.family", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name.family", "min": 1, "mustSupport": true}, {"id": "Practitioner.name.given", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Practitioner.name.given", "mustSupport": true}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: PractitionerRole
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-practitionerrole", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole", "version": "1.1.0-preview", "name": "AUCorePractitionerRole", "title": "AU Core PractitionerRole", "status": "active", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile sets minimum expectations for a PractitionerRole resource to record, search, and fetch a practitioner role for a practitioner associated with a patient. It is based on the [AU Base Practitioner Role](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-practitionerrole.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the PractitionerRole resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping"}, {"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}, {"identity": "servd", "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD"}, {"identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping"}], "kind": "resource", "abstract": false, "type": "PractitionerRole", "baseDefinition": "http://hl7.org.au/fhir/StructureDefinition/au-practitionerrole", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.1.0-preview"}], "element": [{"id": "PractitionerRole", "path": "PractitionerRole", "short": "A person with formal responsibility in a role providing one or more services", "definition": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.", "min": 0, "max": "*", "base": {"path": "PractitionerRole", "min": 0, "max": "*"}, "constraint": [{"key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Entity. Role, or Act"}, {"identity": "v2", "map": "PRD (as one example)"}, {"identity": "rim", "map": "Role"}, {"identity": "servd", "map": "ServiceSiteProvider"}]}, {"id": "PractitionerRole.id", "path": "PractitionerRole.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": {"path": "Resource.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": true}, {"id": "PractitionerRole.meta", "path": "PractitionerRole.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": {"path": "Resource.meta", "min": 0, "max": "1"}, "type": [{"code": "Meta"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true}, {"id": "PractitionerRole.implicitRules", "path": "PractitionerRole.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": {"path": "Resource.implicitRules", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true}, {"id": "PractitionerRole.language", "path": "PractitionerRole.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": {"path": "Resource.language", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language"}], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages"}}, {"id": "PractitionerRole.text", "path": "PractitionerRole.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": ["narrative", "html", "xhtml", "display"], "min": 0, "max": "1", "base": {"path": "DomainResource.text", "min": 0, "max": "1"}, "type": [{"code": "Narrative"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Act.text?"}]}, {"id": "PractitionerRole.contained", "path": "PractitionerRole.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": ["inline resources", "anonymous resources", "contained resources"], "min": 0, "max": "*", "base": {"path": "DomainResource.contained", "min": 0, "max": "*"}, "type": [{"code": "Resource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "PractitionerRole.extension", "path": "PractitionerRole.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "PractitionerRole.modifierExtension", "path": "PractitionerRole.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "PractitionerRole.identifier", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.identifier", "slicing": {"discriminator": [{"type": "pattern", "path": "type"}], "rules": "open"}, "short": "Business Identifiers that are specific to a role/location", "definition": "Business Identifiers that are specific to a role/location.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier", "profile": ["http://hl7.org/fhir/StructureDefinition/Identifier", "http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber", "http://hl7.org.au/fhir/StructureDefinition/au-nationalprovideridentifieratorganisation", "http://hl7.org.au/fhir/StructureDefinition/au-employeenumber"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "PRD-7 (or XCN.1)"}, {"identity": "rim", "map": ".id"}, {"identity": "servd", "map": "./Identifiers"}]}, {"id": "PractitionerRole.identifier:medicareProvider", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.identifier", "sliceName": "medicareProvider", "short": "Business Identifiers that are specific to a role/location", "definition": "Business Identifiers that are specific to a role/location.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "PRD-7 (or XCN.1)"}, {"identity": "rim", "map": ".id"}, {"identity": "servd", "map": "./Identifiers"}]}, {"id": "PractitionerRole.active", "path": "PractitionerRole.active", "short": "Whether this practitioner role record is in active use", "definition": "Whether this practitioner role record is in active use.", "comment": "If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.", "requirements": "Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.active", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.status"}, {"identity": "v2", "map": "STF-7"}, {"identity": "rim", "map": ".statusCode"}]}, {"id": "PractitionerRole.period", "path": "PractitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s)", "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.period", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.done[x]"}, {"identity": "v2", "map": "PRD-8/9 / PRA-5.4"}, {"identity": "rim", "map": ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime"}, {"identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"}]}, {"id": "PractitionerRole.practitioner", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.practitioner", "short": "Practitioner that is able to provide the defined services for the organization", "definition": "Practitioner that is able to provide the defined services for the organization.", "min": 1, "max": "1", "base": {"path": "PractitionerRole.practitioner", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner"]}], "condition": ["au-core-prarol-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "au-core-prarol-01", "severity": "error", "human": "At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present", "expression": "(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()", "xpath": "(exists(f:reference) or exists(f:display) or exists(f:identifier)) and not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])) or not(exists(f:reference) or exists(f:display) or exists(f:identifier)) and exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "rim", "map": ".player"}]}, {"id": "PractitionerRole.organization", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.organization", "short": "Organization where the roles are available", "definition": "The organization where the Practitioner performs the roles associated.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.organization", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "rim", "map": ".scoper"}]}, {"id": "PractitionerRole.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.code", "short": "Roles which this practitioner may perform", "definition": "Roles which this practitioner is authorized to perform for the organization.", "comment": "A person may have more than one role.", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "max": "*", "base": {"path": "PractitionerRole.code", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"strength": "preferred", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1"}, "mapping": [{"identity": "v2", "map": "PRD-1 / STF-18  / PRA-3  / PRT-4  / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17"}, {"identity": "rim", "map": ".code"}, {"identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"}]}, {"id": "PractitionerRole.specialty", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.specialty", "short": "Specific specialty of the practitioner", "definition": "Specific specialty of the practitioner.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.specialty", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"strength": "preferred", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/clinical-specialty-1"}, "mapping": [{"identity": "v2", "map": "PRA-5"}, {"identity": "rim", "map": ".player.HealthCareProvider[@classCode = 'PROV'].code"}, {"identity": "servd", "map": "./Specialty"}]}, {"id": "PractitionerRole.location", "path": "PractitionerRole.location", "short": "The location(s) at which this practitioner provides care", "definition": "The location(s) at which this practitioner provides care.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.location", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Location"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.where[x]"}, {"identity": "rim", "map": ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']"}, {"identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"}]}, {"id": "PractitionerRole.healthcareService", "path": "PractitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "min": 0, "max": "*", "base": {"path": "PractitionerRole.healthcareService", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/HealthcareService"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "EDU-2 / AFF-3"}, {"identity": "rim", "map": ".player.QualifiedEntity[@classCode = 'QUAL'].code"}]}, {"id": "PractitionerRole.telecom", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.telecom", "short": "Contact details that are specific to the role/location/service", "definition": "Contact details that are specific to the role/location/service.", "requirements": "Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.telecom", "min": 0, "max": "*"}, "type": [{"code": "ContactPoint"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "rim", "map": ".telecom"}]}, {"id": "PractitionerRole.availableTime", "path": "PractitionerRole.availableTime", "short": "Times the Service Site is available", "definition": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.", "comment": "More detailed availability information may be provided in associated Schedule/Slot resources.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.availableTime", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availableTime.id", "path": "PractitionerRole.availableTime.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "PractitionerRole.availableTime.extension", "path": "PractitionerRole.availableTime.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "PractitionerRole.availableTime.modifierExtension", "path": "PractitionerRole.availableTime.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "PractitionerRole.availableTime.daysOfWeek", "path": "PractitionerRole.availableTime.daysOfWeek", "short": "mon | tue | wed | thu | fri | sat | sun", "definition": "Indicates which days of the week are available between the start and end Times.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.availableTime.daysOfWeek", "min": 0, "max": "*"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek"}], "strength": "required", "description": "The days of the week.", "valueSet": "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"}, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availableTime.allDay", "path": "PractitionerRole.availableTime.allDay", "short": "Always available? e.g. 24 hour service", "definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.availableTime.allDay", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availableTime.availableStartTime", "path": "PractitionerRole.availableTime.availableStartTime", "short": "Opening time of day (ignored if allDay = true)", "definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.availableTime.availableStartTime", "min": 0, "max": "1"}, "type": [{"code": "time"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availableTime.availableStartTime.id", "path": "PractitionerRole.availableTime.availableStartTime.id", "representation": ["xmlAttr"], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references)", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.availableTime.availableStartTime.extension", "path": "PractitionerRole.availableTime.availableStartTime.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "ordered": false, "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.availableTime.availableStartTime.extension:timeZone", "path": "PractitionerRole.availableTime.availableStartTime.extension", "sliceName": "timeZone", "short": "AU time zone", "definition": "Australian time zone.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-timezone"]}], "condition": ["ele-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "PractitionerRole.availableTime.availableStartTime.value", "path": "PractitionerRole.availableTime.availableStartTime.value", "representation": ["xmlAttr"], "short": "Primitive value for time", "definition": "The actual value", "min": 0, "max": "1", "base": {"path": "time.value", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "time"}, {"url": "http://hl7.org/fhir/StructureDefinition/regex", "valueString": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?"}], "code": "http://hl7.org/fhirpath/System.Time"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.availableTime.availableEndTime", "path": "PractitionerRole.availableTime.availableEndTime", "short": "Closing time of day (ignored if allDay = true)", "definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.availableTime.availableEndTime", "min": 0, "max": "1"}, "type": [{"code": "time"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availableTime.availableEndTime.id", "path": "PractitionerRole.availableTime.availableEndTime.id", "representation": ["xmlAttr"], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references)", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.availableTime.availableEndTime.extension", "path": "PractitionerRole.availableTime.availableEndTime.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "ordered": false, "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.availableTime.availableEndTime.extension:timeZone", "path": "PractitionerRole.availableTime.availableEndTime.extension", "sliceName": "timeZone", "short": "AU time zone", "definition": "Australian time zone.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-timezone"]}], "condition": ["ele-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "PractitionerRole.availableTime.availableEndTime.value", "path": "PractitionerRole.availableTime.availableEndTime.value", "representation": ["xmlAttr"], "short": "Primitive value for time", "definition": "The actual value", "min": 0, "max": "1", "base": {"path": "time.value", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "time"}, {"url": "http://hl7.org/fhir/StructureDefinition/regex", "valueString": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?"}], "code": "http://hl7.org/fhirpath/System.Time"}], "isModifier": false, "isSummary": false}, {"id": "PractitionerRole.notAvailable", "path": "PractitionerRole.notAvailable", "short": "Not available during this time due to provided reason", "definition": "The practitioner is not available or performing this role during this period of time due to the provided reason.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.notAvailable", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.notAvailable.id", "path": "PractitionerRole.notAvailable.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "PractitionerRole.notAvailable.extension", "path": "PractitionerRole.notAvailable.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "PractitionerRole.notAvailable.modifierExtension", "path": "PractitionerRole.notAvailable.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "PractitionerRole.notAvailable.description", "path": "PractitionerRole.notAvailable.description", "short": "Reason presented to the user explaining why time not available", "definition": "The reason that can be presented to the user as to why this time is not available.", "min": 1, "max": "1", "base": {"path": "PractitionerRole.notAvailable.description", "min": 1, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "PractitionerRole.notAvailable.during", "path": "PractitionerRole.notAvailable.during", "short": "Service not available from this date", "definition": "Service is not available (seasonally or for a public holiday) from this date.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.notAvailable.during", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.availabilityExceptions", "path": "PractitionerRole.availabilityExceptions", "short": "Description of availability exceptions", "definition": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.", "min": 0, "max": "1", "base": {"path": "PractitionerRole.availabilityExceptions", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".effectiveTime"}]}, {"id": "PractitionerRole.endpoint", "path": "PractitionerRole.endpoint", "short": "Technical endpoints providing access to services operated for the practitioner with this role", "definition": "Technical endpoints providing access to services operated for the practitioner with this role.", "requirements": "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\r\rSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.", "min": 0, "max": "*", "base": {"path": "PractitionerRole.endpoint", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Endpoint"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}]}, "differential": {"element": [{"id": "PractitionerRole", "path": "PractitionerRole", "short": "A person with formal responsibility in a role providing one or more services"}, {"id": "PractitionerRole.identifier", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.identifier", "slicing": {"discriminator": [{"type": "pattern", "path": "type"}], "rules": "open"}, "definition": "Business Identifiers that are specific to a role/location.", "mustSupport": true}, {"id": "PractitionerRole.identifier:medicareProvider", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.identifier", "sliceName": "medicareProvider", "max": "1", "type": [{"code": "Identifier", "profile": ["http://hl7.org.au/fhir/StructureDefinition/au-medicareprovidernumber"]}], "mustSupport": true}, {"id": "PractitionerRole.practitioner", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.practitioner", "min": 1, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner"]}], "condition": ["au-core-prarol-01"], "constraint": [{"key": "au-core-prarol-01", "severity": "error", "human": "At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present", "expression": "(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()", "xpath": "(exists(f:reference) or exists(f:display) or exists(f:identifier)) and not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])) or not(exists(f:reference) or exists(f:display) or exists(f:identifier)) and exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole"}], "mustSupport": true}, {"id": "PractitionerRole.organization", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.organization", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization"]}], "mustSupport": true}, {"id": "PractitionerRole.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.code", "mustSupport": true}, {"id": "PractitionerRole.specialty", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.specialty", "mustSupport": true}, {"id": "PractitionerRole.telecom", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "PractitionerRole.telecom", "mustSupport": true}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: Procedure
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-procedure", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure", "version": "1.1.0-preview", "name": "AUCoreProcedure", "title": "AU Core Procedure", "status": "active", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile sets minimum expectations for a Procedure resource to record, search, and fetch procedures associated with a patient. It is based on the [AU Base Procedure](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-procedure.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Procedure resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern"}, {"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}, {"identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping"}, {"identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping"}], "kind": "resource", "abstract": false, "type": "Procedure", "baseDefinition": "http://hl7.org.au/fhir/StructureDefinition/au-procedure", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.1.0-preview"}], "element": [{"id": "Procedure", "path": "Procedure", "short": "A procedure in an Australian healthcare context", "definition": "An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.", "min": 0, "max": "*", "base": {"path": "Procedure", "min": 0, "max": "*"}, "constraint": [{"key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Entity. Role, or Act"}, {"identity": "workflow", "map": "Event"}, {"identity": "rim", "map": "Procedure[moodCode=EVN]"}]}, {"id": "Procedure.id", "path": "Procedure.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": {"path": "Resource.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": true}, {"id": "Procedure.meta", "path": "Procedure.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": {"path": "Resource.meta", "min": 0, "max": "1"}, "type": [{"code": "Meta"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true}, {"id": "Procedure.implicitRules", "path": "Procedure.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": {"path": "Resource.implicitRules", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true}, {"id": "Procedure.language", "path": "Procedure.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": {"path": "Resource.language", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language"}], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages"}}, {"id": "Procedure.text", "path": "Procedure.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": ["narrative", "html", "xhtml", "display"], "min": 0, "max": "1", "base": {"path": "DomainResource.text", "min": 0, "max": "1"}, "type": [{"code": "Narrative"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Act.text?"}]}, {"id": "Procedure.contained", "path": "Procedure.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": ["inline resources", "anonymous resources", "contained resources"], "min": 0, "max": "*", "base": {"path": "DomainResource.contained", "min": 0, "max": "*"}, "type": [{"code": "Resource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Procedure.extension", "path": "Procedure.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Procedure.extension:targetBodyStructure", "path": "Procedure.extension", "sliceName": "targetBodyStructure", "short": "The target point for this procedure", "definition": "The target body site used for this procedure.  Multiple locations are allowed.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "Procedure.modifierExtension", "path": "Procedure.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Procedure.identifier", "path": "Procedure.identifier", "short": "External Identifiers for this procedure", "definition": "Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.", "comment": "This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/resource.html#identifiers)).  It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.  For example, multiple Patient and Person resource instances might share the same social insurance number.", "requirements": "Allows identification of the procedure as it is known by various participating systems and in a way that remains consistent across servers.", "min": 0, "max": "*", "base": {"path": "Procedure.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.identifier"}, {"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "Some combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4"}, {"identity": "rim", "map": ".id"}]}, {"id": "Procedure.instantiatesCanonical", "path": "Procedure.instantiatesCanonical", "short": "Instantiates FHIR protocol or definition", "definition": "The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.instantiatesCanonical", "min": 0, "max": "*"}, "type": [{"code": "canonical", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/PlanDefinition", "http://hl7.org/fhir/StructureDefinition/ActivityDefinition", "http://hl7.org/fhir/StructureDefinition/Measure", "http://hl7.org/fhir/StructureDefinition/OperationDefinition", "http://hl7.org/fhir/StructureDefinition/Questionnaire"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.instantiatesCanonical"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target"}]}, {"id": "Procedure.instantiatesUri", "path": "Procedure.instantiatesUri", "short": "Instantiates external protocol or definition", "definition": "The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.", "comment": "This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.", "min": 0, "max": "*", "base": {"path": "Procedure.instantiatesUri", "min": 0, "max": "*"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.instantiatesUri"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target"}]}, {"id": "Procedure.basedOn", "path": "Procedure.basedOn", "short": "A request for this procedure", "definition": "A reference to a resource that contains details of the request for this procedure.", "alias": ["fulfills"], "min": 0, "max": "*", "base": {"path": "Procedure.basedOn", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.basedOn"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[classCode=(various e.g. PROC, OBS, PCPR, ACT,  moodCode=RQO].code"}]}, {"id": "Procedure.partOf", "path": "Procedure.partOf", "short": "Part of referenced event", "definition": "A larger event of which this particular procedure is a component or step.", "comment": "The MedicationAdministration resource has a partOf reference to Procedure, but this is not a circular reference.   For example, the anesthesia MedicationAdministration is part of the surgical Procedure (MedicationAdministration.partOf = Procedure).  For example, the procedure to insert the IV port for an IV medication administration is part of the medication administration (Procedure.partOf = MedicationAdministration).", "alias": ["container"], "min": 0, "max": "*", "base": {"path": "Procedure.partOf", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.partOf"}, {"identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=SBADM or PROC or OBS, moodCode=EVN]"}]}, {"id": "Procedure.status", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.status", "short": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "definition": "A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.", "comment": "The \"unknown\" code is not to be used to convey other statuses.  The \"unknown\" code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the procedure.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min": 1, "max": "1", "base": {"path": "Procedure.status", "min": 1, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureStatus"}], "strength": "required", "description": "A code specifying the state of the procedure.", "valueSet": "http://hl7.org/fhir/ValueSet/event-status|4.0.1"}, "mapping": [{"identity": "workflow", "map": "Event.status"}, {"identity": "w5", "map": "FiveWs.status"}, {"identity": "rim", "map": "statusCode"}]}, {"id": "Procedure.statusReason", "path": "Procedure.statusReason", "short": "Reason for current status", "definition": "Captures the reason for the current state of the procedure.", "comment": "This is generally only used for \"exception\" statuses such as \"not-done\", \"suspended\" or \"aborted\". The reason for performing the event at all is captured in reasonCode, not here.", "alias": ["Suspended Reason", "Cancelled Reason"], "min": 0, "max": "1", "base": {"path": "Procedure.statusReason", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureNegationReason"}], "strength": "example", "description": "A code that identifies the reason a procedure was not performed.", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-not-performed-reason"}, "mapping": [{"identity": "workflow", "map": "Event.statusReason"}, {"identity": "rim", "map": ".reason.Observation.value"}]}, {"id": "Procedure.category", "path": "Procedure.category", "short": "Classification of the procedure", "definition": "A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\").", "min": 0, "max": "1", "base": {"path": "Procedure.category", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureCategory"}], "strength": "example", "description": "A code that classifies a procedure for searching, sorting and display purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-category"}, "mapping": [{"identity": "w5", "map": "FiveWs.class"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]}, {"id": "Procedure.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.code", "short": "Identification of the procedure", "definition": "The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\").", "requirements": "0..1 to account for primarily narrative only resources.", "alias": ["type"], "min": 1, "max": "1", "base": {"path": "Procedure.code", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/procedure-1"}, "mapping": [{"identity": "workflow", "map": "Event.code"}, {"identity": "w5", "map": "FiveWs.what[x]"}, {"identity": "v2", "map": "OBR-44/OBR-45"}, {"identity": "rim", "map": ".code"}]}, {"id": "Procedure.subject", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.subject", "short": "Who the procedure was performed on", "definition": "The person, animal or group on which the procedure was performed.", "alias": ["patient"], "min": 1, "max": "1", "base": {"path": "Procedure.subject", "min": 1, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.subject"}, {"identity": "w5", "map": "FiveWs.subject[x]"}, {"identity": "v2", "map": "PID-3"}, {"identity": "rim", "map": ".participation[typeCode=SBJ].role"}, {"identity": "w5", "map": "FiveWs.subject"}]}, {"id": "Procedure.encounter", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.encounter", "short": "Encounter created as part of", "definition": "The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.", "comment": "This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.", "min": 0, "max": "1", "base": {"path": "Procedure.encounter", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.context"}, {"identity": "w5", "map": "FiveWs.context"}, {"identity": "v2", "map": "PV1-19"}, {"identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]}, {"id": "Procedure.performed[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.performed[x]", "short": "When the procedure was performed", "definition": "Estimated or actual date, date-time, period, or age when the procedure was performed.  Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.", "comment": "Age is generally used when the patient reports an age at which the procedure was performed. Range is generally used when the patient reports an age range when the procedure was performed, such as sometime between 20-25 years old.  dateTime supports a range of precision due to some procedures being reported as past procedures that might not have millisecond precision while other procedures performed and documented during the encounter might have more precise UTC timestamps with timezone.", "min": 0, "max": "1", "base": {"path": "Procedure.performed[x]", "min": 0, "max": "1"}, "type": [{"code": "dateTime"}, {"code": "Period"}, {"code": "string"}, {"code": "Age"}, {"code": "Range"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.occurrence[x]"}, {"identity": "w5", "map": "FiveWs.done[x]"}, {"identity": "v2", "map": "OBR-7"}, {"identity": "rim", "map": ".effectiveTime"}]}, {"id": "Procedure.recorder", "path": "Procedure.recorder", "short": "Who recorded the procedure", "definition": "Individual who recorded the record and takes responsibility for its content.", "min": 0, "max": "1", "base": {"path": "Procedure.recorder", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.author"}, {"identity": "rim", "map": ".participation[typeCode=AUT].role"}]}, {"id": "Procedure.asserter", "path": "Procedure.asserter", "short": "Person who asserts this procedure", "definition": "Individual who is making the procedure statement.", "min": 0, "max": "1", "base": {"path": "Procedure.asserter", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.source"}, {"identity": "rim", "map": ".participation[typeCode=INF].role"}]}, {"id": "Procedure.performer", "path": "Procedure.performer", "short": "The people who performed the procedure", "definition": "Limited to \"real\" people rather than equipment.", "min": 0, "max": "*", "base": {"path": "Procedure.performer", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.performer"}, {"identity": "rim", "map": ".participation[typeCode=PRF]"}]}, {"id": "Procedure.performer.id", "path": "Procedure.performer.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Procedure.performer.extension", "path": "Procedure.performer.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Procedure.performer.modifierExtension", "path": "Procedure.performer.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Procedure.performer.function", "path": "Procedure.performer.function", "short": "Type of performance", "definition": "Distinguishes the type of involvement of the performer in the procedure. For example, surgeon, anaesthetist, endoscopist.", "requirements": "Allows disambiguation of the types of involvement of different performers.", "min": 0, "max": "1", "base": {"path": "Procedure.performer.function", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedurePerformerRole"}], "strength": "example", "description": "A code that identifies the role of a performer of the procedure.", "valueSet": "http://hl7.org/fhir/ValueSet/performer-role"}, "mapping": [{"identity": "workflow", "map": "Event.performer.function"}, {"identity": "v2", "map": "Some combination of STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 / OBX-25"}, {"identity": "rim", "map": ".functionCode"}]}, {"id": "Procedure.performer.actor", "path": "Procedure.performer.actor", "short": "The reference to the practitioner", "definition": "The practitioner who was involved in the procedure.", "requirements": "A reference to Device supports use cases, such as pacemakers.", "min": 1, "max": "1", "base": {"path": "Procedure.performer.actor", "min": 1, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Device"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.performer.actor"}, {"identity": "w5", "map": "FiveWs.actor"}, {"identity": "v2", "map": "ORC-19/PRT-5"}, {"identity": "rim", "map": ".role"}]}, {"id": "Procedure.performer.onBehalfOf", "path": "Procedure.performer.onBehalfOf", "short": "Organization the device or practitioner was acting for", "definition": "The organization the device or practitioner was acting on behalf of.", "requirements": "Practitioners and Devices can be associated with multiple organizations.  This element indicates which organization they were acting on behalf of when performing the action.", "min": 0, "max": "1", "base": {"path": "Procedure.performer.onBehalfOf", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".scoper"}]}, {"id": "Procedure.location", "path": "Procedure.location", "short": "Where the procedure happened", "definition": "The location where the procedure actually happened.  E.g. a newborn at home, a tracheostomy at a restaurant.", "requirements": "Ties a procedure to where the records are likely kept.", "min": 0, "max": "1", "base": {"path": "Procedure.location", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Location"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.where[x]"}, {"identity": "rim", "map": ".participation[typeCode=LOC].role[classCode=SDLOC]"}]}, {"id": "Procedure.reasonCode", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.reasonCode", "short": "Coded reason procedure performed", "definition": "The coded reason why the procedure was performed. This may be a coded entity of some type, or may simply be present as text.", "comment": "Use Procedure.reasonCode when a code sufficiently describes the reason.  Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative.  For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used.  Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference.  Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.reasonCode", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureReason"}], "strength": "example", "description": "A code that identifies the reason a procedure is  required.", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-reason"}, "mapping": [{"identity": "workflow", "map": "Event.reasonCode"}, {"identity": "w5", "map": "FiveWs.why[x]"}, {"identity": "rim", "map": ".reasonCode"}]}, {"id": "Procedure.reasonReference", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.reasonReference", "short": "The justification that the procedure was performed", "definition": "The justification of why the procedure was performed.", "comment": "It is possible for a procedure to be a reason (such as C-Section) for another procedure (such as an epidural). Other examples include endoscopy for dilatation and biopsy (a combination of diagnostic and therapeutic use). \nUse Procedure.reasonCode when a code sufficiently describes the reason.  Use Procedure.reasonReference when referencing a resource, which allows more information to be conveyed, such as onset date. Procedure.reasonCode and Procedure.reasonReference are not meant to be duplicative.  For a single reason, either Procedure.reasonCode or Procedure.reasonReference can be used.  Procedure.reasonCode may be a summary code, or Procedure.reasonReference may be used to reference a very precise definition of the reason using Condition | Observation | Procedure | DiagnosticReport | DocumentReference.  Both Procedure.reasonCode and Procedure.reasonReference can be used if they are describing different reasons for the procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.reasonReference", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure", "http://hl7.org/fhir/StructureDefinition/DocumentReference"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.reasonReference"}, {"identity": "w5", "map": "FiveWs.why[x]"}, {"identity": "rim", "map": ".reasonCode"}]}, {"id": "Procedure.bodySite", "path": "Procedure.bodySite", "short": "Target body sites", "definition": "Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.", "comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [procedure-targetbodystructure](http://hl7.org/fhir/R4/extension-procedure-targetbodystructure.html).", "min": 0, "max": "*", "base": {"path": "Procedure.bodySite", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "condition": ["au-core-pro-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "au-core-pro-01", "severity": "error", "human": "If a coded body site is provided, at least one coding shall be from SNOMED CT", "expression": "coding.exists() implies coding.where(system='http://snomed.info/sct').exists()", "xpath": "not(exists(f:coding/f:system)) or exists(f:coding/f:system[@value='http://snomed.info/sct'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure"}], "isModifier": false, "isSummary": true, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/body-site-1"}, "mapping": [{"identity": "v2", "map": "OBX-20"}, {"identity": "rim", "map": ".targetSiteCode"}]}, {"id": "Procedure.outcome", "path": "Procedure.outcome", "short": "The result of procedure", "definition": "The outcome of the procedure - did it resolve the reasons for the procedure being performed?", "comment": "If outcome contains narrative text only, it can be captured using the CodeableConcept.text.", "min": 0, "max": "1", "base": {"path": "Procedure.outcome", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureOutcome"}], "strength": "example", "description": "An outcome of a procedure - whether it was resolved or otherwise.", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-outcome"}, "mapping": [{"identity": "rim", "map": ".outboundRelationship[typeCode=OUT].target.text"}]}, {"id": "Procedure.report", "path": "Procedure.report", "short": "Any report resulting from the procedure", "definition": "This could be a histology result, pathology report, surgical report, etc.", "comment": "There could potentially be multiple reports - e.g. if this was a procedure which took multiple biopsies resulting in a number of anatomical pathology reports.", "min": 0, "max": "*", "base": {"path": "Procedure.report", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/DiagnosticReport", "http://hl7.org/fhir/StructureDefinition/DocumentReference", "http://hl7.org/fhir/StructureDefinition/Composition"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]"}]}, {"id": "Procedure.complication", "path": "Procedure.complication", "short": "Complication following the procedure", "definition": "Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.", "comment": "If complications are only expressed by the narrative text, they can be captured using the CodeableConcept.text.", "min": 0, "max": "*", "base": {"path": "Procedure.complication", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureComplication"}], "strength": "example", "description": "Codes describing complications that resulted from a procedure.", "valueSet": "http://hl7.org/fhir/ValueSet/condition-code"}, "mapping": [{"identity": "rim", "map": ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"}]}, {"id": "Procedure.complicationDetail", "path": "Procedure.complicationDetail", "short": "A condition that is a result of the procedure", "definition": "Any complications that occurred during the procedure, or in the immediate post-performance period.", "requirements": "This is used to document a condition that is a result of the procedure, not the condition that was the reason for the procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.complicationDetail", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Condition"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".outboundRelationship[typeCode=OUTC].target[classCode=OBS, code=\"complication\", moodCode=EVN].value"}]}, {"id": "Procedure.followUp", "path": "Procedure.followUp", "short": "Instructions for follow up", "definition": "If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.", "min": 0, "max": "*", "base": {"path": "Procedure.followUp", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureFollowUp"}], "strength": "example", "description": "Specific follow up required for a procedure e.g. removal of sutures.", "valueSet": "http://hl7.org/fhir/ValueSet/procedure-followup"}, "mapping": [{"identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code"}]}, {"id": "Procedure.note", "path": "Procedure.note", "short": "Additional information about the procedure", "definition": "Any other notes and comments about the procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.note", "min": 0, "max": "*"}, "type": [{"code": "Annotation"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "workflow", "map": "Event.note"}, {"identity": "v2", "map": "NTE"}, {"identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"}]}, {"id": "Procedure.focalDevice", "path": "Procedure.focalDevice", "short": "Manipulated, implanted, or removed device", "definition": "A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.", "min": 0, "max": "*", "base": {"path": "Procedure.focalDevice", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=MANU]"}]}, {"id": "Procedure.focalDevice.id", "path": "Procedure.focalDevice.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Procedure.focalDevice.extension", "path": "Procedure.focalDevice.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Procedure.focalDevice.modifierExtension", "path": "Procedure.focalDevice.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Procedure.focalDevice.action", "path": "Procedure.focalDevice.action", "short": "Kind of change to device", "definition": "The kind of change that happened to the device during the procedure.", "min": 0, "max": "1", "base": {"path": "Procedure.focalDevice.action", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DeviceActionKind"}], "strength": "preferred", "description": "A kind of change that happened to the device during the procedure.", "valueSet": "http://hl7.org/fhir/ValueSet/device-action"}, "mapping": [{"identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"procedure device action\"].value=:procedure device action codes"}]}, {"id": "Procedure.focalDevice.manipulated", "path": "Procedure.focalDevice.manipulated", "short": "Device that was changed", "definition": "The device that was manipulated (changed) during the procedure.", "min": 1, "max": "1", "base": {"path": "Procedure.focalDevice.manipulated", "min": 1, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Device"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=SDLOC]"}]}, {"id": "Procedure.usedReference", "path": "Procedure.usedReference", "short": "Items used during procedure", "definition": "Identifies medications, devices and any other substance used as part of the procedure.", "comment": "For devices actually implanted or removed, use Procedure.device.", "requirements": "Used for tracking contamination, etc.", "min": 0, "max": "*", "base": {"path": "Procedure.usedReference", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Medication", "http://hl7.org/fhir/StructureDefinition/Substance"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": ".participation[typeCode=DEV].role[classCode=MANU] or\n.participation[typeCode=CSM].role[classCode=ADMM] (for Medication or Substance)"}]}, {"id": "Procedure.usedCode", "path": "Procedure.usedCode", "short": "Coded items used during the procedure", "definition": "Identifies coded items that were used as part of the procedure.", "comment": "For devices actually implanted or removed, use Procedure.device.", "min": 0, "max": "*", "base": {"path": "Procedure.usedCode", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ProcedureUsed"}], "strength": "example", "description": "Codes describing items used during a procedure.", "valueSet": "http://hl7.org/fhir/ValueSet/device-kind"}, "mapping": [{"identity": "rim", "map": "participation[typeCode=Dev].role[classCode=MANU]"}]}]}, "differential": {"element": [{"id": "Procedure", "path": "Procedure"}, {"id": "Procedure.status", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.status", "mustSupport": true}, {"id": "Procedure.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.code", "min": 1, "mustSupport": true, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/procedure-1"}}, {"id": "Procedure.subject", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.subject", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}], "mustSupport": true}, {"id": "Procedure.encounter", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.encounter", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter"]}], "mustSupport": true}, {"id": "Procedure.performed[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.performed[x]", "mustSupport": true}, {"id": "Procedure.reasonCode", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.reasonCode", "mustSupport": true}, {"id": "Procedure.reasonReference", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Procedure.reasonReference", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure", "http://hl7.org/fhir/StructureDefinition/DocumentReference"]}], "mustSupport": true}, {"id": "Procedure.bodySite", "path": "Procedure.bodySite", "condition": ["au-core-pro-01"], "constraint": [{"key": "au-core-pro-01", "severity": "error", "human": "If a coded body site is provided, at least one coding shall be from SNOMED CT", "expression": "coding.exists() implies coding.where(system='http://snomed.info/sct').exists()", "xpath": "not(exists(f:coding/f:system)) or exists(f:coding/f:system[@value='http://snomed.info/sct'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure"}], "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/body-site-1"}}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: RelatedPerson
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-relatedperson", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 0}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson", "version": "1.1.0-preview", "name": "AUCoreRelatedPerson", "title": "AU Core RelatedPerson", "status": "draft", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile sets minimum expectations for a RelatedPerson resource to record, search, and fetch basic demographics and other administrative information about individual related persons associated with a patient. It is based on the [AU Base Related Person](http://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-relatedperson.html) profile and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the RelatedPerson resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}, {"identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping"}, {"identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping"}], "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.1.0-preview"}], "element": [{"id": "RelatedPerson", "path": "RelatedPerson", "short": "A person related to a patient in an Australian healthcare context", "definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", "min": 0, "max": "*", "base": {"path": "RelatedPerson", "min": 0, "max": "*"}, "constraint": [{"key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "inv-relper-0", "severity": "warning", "human": "Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson"}, {"key": "inv-relper-1", "severity": "warning", "human": "Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson"}, {"key": "inv-relper-2", "severity": "warning", "human": "Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson"}, {"key": "inv-relper-3", "severity": "warning", "human": "Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-source-document-type'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson"}, {"key": "inv-relper-4", "severity": "warning", "human": "Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply", "expression": "extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended'))", "source": "http://hl7.org.au/fhir/StructureDefinition/au-relatedperson"}, {"key": "au-core-relper-01", "severity": "error", "human": "Either a name or a relationship shall be provided (or both)", "expression": "name.exists() or relationship.exists()", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson"}, {"key": "au-core-relper-02", "severity": "error", "human": "Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present", "expression": "name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Entity. Role, or Act"}, {"identity": "rim", "map": "role"}]}, {"id": "RelatedPerson.id", "path": "RelatedPerson.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": {"path": "Resource.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": true}, {"id": "RelatedPerson.meta", "path": "RelatedPerson.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": {"path": "Resource.meta", "min": 0, "max": "1"}, "type": [{"code": "Meta"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true}, {"id": "RelatedPerson.implicitRules", "path": "RelatedPerson.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": {"path": "Resource.implicitRules", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true}, {"id": "RelatedPerson.language", "path": "RelatedPerson.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": {"path": "Resource.language", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language"}], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages"}}, {"id": "RelatedPerson.text", "path": "RelatedPerson.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": ["narrative", "html", "xhtml", "display"], "min": 0, "max": "1", "base": {"path": "DomainResource.text", "min": 0, "max": "1"}, "type": [{"code": "Narrative"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Act.text?"}]}, {"id": "RelatedPerson.contained", "path": "RelatedPerson.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": ["inline resources", "anonymous resources", "contained resources"], "min": 0, "max": "*", "base": {"path": "DomainResource.contained", "min": 0, "max": "*"}, "type": [{"code": "Resource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "RelatedPerson.extension", "path": "RelatedPerson.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "RelatedPerson.extension:genderIdentity", "path": "RelatedPerson.extension", "sliceName": "genderIdentity", "short": "Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply", "definition": "An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else.", "comment": "The individual's gender identity is populated in the `extension:value.value[x]` of the [Individual Gender Identity](http://hl7.org/fhir/StructureDefinition/individual-genderIdentity) extension and shall contain one of the codes from the [Gender Identity Response](https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1) value set if any of the codes within the value set can apply.\n\nSee [Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020](https://www.abs.gov.au/statistics/standards/standard-sex-gender-variations-sex-characteristics-and-sexual-orientation-variables/latest-release#gender) for further materials.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"]}], "condition": ["inv-relper-0"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "RelatedPerson.extension:individualPronouns", "path": "RelatedPerson.extension", "sliceName": "individualPronouns", "short": "Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply", "definition": "The pronouns to use when referring to an individual in verbal or written communication.", "comment": "The individual's pronouns are populated in the `extension:value.value[x]` of the [Individual Pronouns](http://hl7.org/fhir/StructureDefinition/individual-pronouns) extension and shall contain one of the codes from the [Australian Pronouns](https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1) value set if any of the codes within the value set can apply.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-pronouns"]}], "condition": ["inv-relper-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "RelatedPerson.extension:recordedSexOrGender", "path": "RelatedPerson.extension", "sliceName": "recordedSexOrGender", "short": "Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended if any codes within that value set can apply", "definition": "A sex or gender property for the individual from a document or other record", "comment": "The type of recorded sex or gender is populated in the `extension:type.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender Type](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-rsg-type.html) value set if any of the codes within the value set can apply.\n\nThe document from which the sex or gender property was acquired is populated in the `extension:sourceDocument.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [AU Recorded Sex or Gender (RSG) Source Document Type](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-rsg-source-document-type.html) value set if any of the codes within the value set can apply.\n\nThe jurisdiction that issued the document where the sex or gender was acquired is populated in the `extension:jurisdiction.value[x]` of the [Person Recorded Sex or Gender](http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender) extension and shall contain one of the codes from the [Jurisdiction ValueSet - AU Extended](https://build.fhir.org/ig/hl7au/au-fhir-base/ValueSet-au-jurisdiction-extended.html) value set if any of the codes within the value set can apply.", "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension", "profile": ["http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"]}], "condition": ["inv-relper-2", "inv-relper-3", "inv-relper-4"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "RelatedPerson.modifierExtension", "path": "RelatedPerson.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "short": "A human identifier for this person", "definition": "Identifier for a person within a particular scope.", "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier", "profile": ["http://hl7.org/fhir/StructureDefinition/Identifier", "http://hl7.org.au/fhir/StructureDefinition/au-ihi", "http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber", "http://hl7.org.au/fhir/StructureDefinition/au-dvanumber", "http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber", "http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber", "http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber", "http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber", "http://hl7.org.au/fhir/StructureDefinition/au-insurancemembernumber"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "NK1-33"}, {"identity": "rim", "map": ".id"}]}, {"id": "RelatedPerson.active", "path": "RelatedPerson.active", "short": "Whether this related person's record is in active use", "definition": "Whether this related person record is in active use.", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.", "min": 0, "max": "1", "base": {"path": "RelatedPerson.active", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid", "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.status"}, {"identity": "rim", "map": ".statusCode"}]}, {"id": "RelatedPerson.patient", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.patient", "short": "The patient this person is related to", "definition": "The patient this person is related to.", "requirements": "We need to know which patient this RelatedPerson is related to.", "min": 1, "max": "1", "base": {"path": "RelatedPerson.patient", "min": 1, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "PID-3"}, {"identity": "rim", "map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id"}]}, {"id": "RelatedPerson.relationship", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.relationship", "short": "The nature of the relationship", "definition": "The nature of the relationship between a patient and the related person.", "requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.relationship", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "condition": ["au-core-relper-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientRelationshipType"}], "strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/related-person-relationship-type-1"}, "mapping": [{"identity": "w5", "map": "FiveWs.class"}, {"identity": "v2", "map": "NK1-3"}, {"identity": "rim", "map": "code"}]}, {"id": "RelatedPerson.name", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name", "short": "A name associated with the person", "definition": "A name associated with the person.", "requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.name", "min": 0, "max": "*"}, "type": [{"code": "HumanName"}], "condition": ["au-core-relper-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "NK1-2"}, {"identity": "rim", "map": "name"}]}, {"id": "RelatedPerson.name.id", "path": "RelatedPerson.name.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "RelatedPerson.name.extension", "path": "RelatedPerson.name.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "RelatedPerson.name.use", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "base": {"path": "HumanName.use", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse"}], "strength": "required", "description": "The use of a human name.", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1"}, "mapping": [{"identity": "v2", "map": "XPN.7, but often indicated by which field contains the name"}, {"identity": "rim", "map": "unique(./use)"}, {"identity": "servd", "map": "./NamePurpose"}]}, {"id": "RelatedPerson.name.text", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.text", "short": "Text representation of the full name", "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present,  no content is included in the text that isn't found in a part.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": {"path": "HumanName.text", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "implied by XPN.11"}, {"identity": "rim", "map": "./formatted"}]}, {"id": "RelatedPerson.name.family", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "alias": ["surname"], "min": 0, "max": "1", "base": {"path": "HumanName.family", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.1/FN.1"}, {"identity": "rim", "map": "./part[partType = FAM]"}, {"identity": "servd", "map": "./FamilyName"}]}, {"id": "RelatedPerson.name.given", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given name.", "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations.  This element is not called \"first name\" since given names do not always come first.", "alias": ["first name", "middle name"], "min": 0, "max": "*", "base": {"path": "HumanName.given", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Given Names appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.2 + XPN.3"}, {"identity": "rim", "map": "./part[partType = GIV]"}, {"identity": "servd", "map": "./GivenNames"}]}, {"id": "RelatedPerson.name.prefix", "path": "RelatedPerson.name.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "*", "base": {"path": "HumanName.prefix", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Prefixes appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.5"}, {"identity": "rim", "map": "./part[partType = PFX]"}, {"identity": "servd", "map": "./TitleCode"}]}, {"id": "RelatedPerson.name.suffix", "path": "RelatedPerson.name.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "*", "base": {"path": "HumanName.suffix", "min": 0, "max": "*"}, "type": [{"code": "string"}], "orderMeaning": "Suffixes appear in the correct order for presenting the name", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN/4"}, {"identity": "rim", "map": "./part[partType = SFX]"}]}, {"id": "RelatedPerson.name.period", "path": "RelatedPerson.name.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "base": {"path": "HumanName.period", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "XPN.13 + XPN.14"}, {"identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]"}, {"identity": "servd", "map": "./StartDate and ./EndDate"}]}, {"id": "RelatedPerson.telecom", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.telecom", "short": "A contact detail for the person", "definition": "A contact detail for the person, e.g. a telephone number or an email address.", "comment": "Person may have multiple ways to be contacted with different uses or applicable periods.  May need to have options for contacting the person urgently, and also to help with identification.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.telecom", "min": 0, "max": "*"}, "type": [{"code": "ContactPoint"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "NK1-5 / NK1-6 / NK1-40"}, {"identity": "rim", "map": "telecom"}]}, {"id": "RelatedPerson.gender", "path": "RelatedPerson.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "requirements": "Needed for identification of the person, in combination with (at least) name and birth date.", "min": 0, "max": "1", "base": {"path": "RelatedPerson.gender", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender"}], "strength": "required", "description": "The gender of a person used for administrative purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1"}, "mapping": [{"identity": "v2", "map": "NK1-15"}, {"identity": "rim", "map": "administrativeGender"}]}, {"id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "short": "The date on which the related person was born", "definition": "The date on which the related person was born.", "min": 0, "max": "1", "base": {"path": "RelatedPerson.birthDate", "min": 0, "max": "1"}, "type": [{"code": "date"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "rim", "map": "player.birthTime"}]}, {"id": "RelatedPerson.address", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.address", "short": "Address where the related person can be contacted or visited", "definition": "Address where the related person can be contacted or visited.", "comment": "The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).", "requirements": "Need to keep track where the related person can be contacted per postal mail or visited.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.address", "min": 0, "max": "*"}, "type": [{"code": "Address", "profile": ["http://hl7.org/fhir/StructureDefinition/Address", "http://hl7.org.au/fhir/StructureDefinition/au-address"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "NK1-4"}, {"identity": "rim", "map": "addr"}]}, {"id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "short": "Image of the person", "definition": "Image of the person.", "requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.photo", "min": 0, "max": "*"}, "type": [{"code": "Attachment"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX-5 - needs a profile"}, {"identity": "rim", "map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc"}]}, {"id": "RelatedPerson.period", "path": "RelatedPerson.period", "short": "Period of time that this relationship is considered valid", "definition": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.", "min": 0, "max": "1", "base": {"path": "RelatedPerson.period", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "w5", "map": "FiveWs.done[x]"}, {"identity": "rim", "map": ".effectiveTime"}]}, {"id": "RelatedPerson.communication", "path": "RelatedPerson.communication", "short": "A language which may be used to communicate with about the patient's health", "definition": "A language which may be used to communicate with about the patient's health.", "comment": "If no language is specified, this *implies* that the default local language is spoken.  If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations.   If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.", "requirements": "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.", "min": 0, "max": "*", "base": {"path": "RelatedPerson.communication", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "LanguageCommunication"}]}, {"id": "RelatedPerson.communication.id", "path": "RelatedPerson.communication.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "RelatedPerson.communication.extension", "path": "RelatedPerson.communication.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "RelatedPerson.communication.modifierExtension", "path": "RelatedPerson.communication.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "RelatedPerson.communication.language", "path": "RelatedPerson.communication.language", "short": "The language which can be used to communicate with the patient about his or her health", "definition": "A language which can be used to communicate with about the patient's health.          The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and          the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English,          or \"en-US\" for American English versus \"en-EN\" for England English.", "comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.", "requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.", "min": 1, "max": "1", "base": {"path": "RelatedPerson.communication.language", "min": 1, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2"}, "mapping": [{"identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"}]}, {"id": "RelatedPerson.communication.preferred", "path": "RelatedPerson.communication.preferred", "short": "Language preference indicator", "definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", "comment": "This language is specifically identified for communicating healthcare information.", "requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.", "min": 0, "max": "1", "base": {"path": "RelatedPerson.communication.preferred", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "preferenceInd"}]}]}, "differential": {"element": [{"id": "RelatedPerson", "path": "RelatedPerson", "constraint": [{"key": "au-core-relper-01", "severity": "error", "human": "Either a name or a relationship shall be provided (or both)", "expression": "name.exists() or relationship.exists()", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson"}, {"key": "au-core-relper-02", "severity": "error", "human": "Names shall have at least text, family name, or given name present, or if neither is available, the Data Absent Reason extension shall be present", "expression": "name.exists() implies name.extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists() xor name.all(text.exists() or family.exists() or given.exists())", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-relatedperson"}]}, {"id": "RelatedPerson.patient", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.patient", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}], "mustSupport": true}, {"id": "RelatedPerson.relationship", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.relationship", "condition": ["au-core-relper-01"], "mustSupport": true}, {"id": "RelatedPerson.name", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name", "condition": ["au-core-relper-01"], "mustSupport": true}, {"id": "RelatedPerson.name.use", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.use", "mustSupport": true}, {"id": "RelatedPerson.name.text", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.text", "mustSupport": true}, {"id": "RelatedPerson.name.family", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.family", "mustSupport": true}, {"id": "RelatedPerson.name.given", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.name.given", "mustSupport": true}, {"id": "RelatedPerson.telecom", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.telecom", "mustSupport": true}, {"id": "RelatedPerson.address", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "RelatedPerson.address", "mustSupport": true}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: Extension
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-rsg-sexassignedab", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics", "valueCode": "can-bind"}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-rsg-sexassignedab", "version": "1.1.0-preview", "name": "AUCoreSexAssignedAtBirth", "title": "AU Core Sex Assigned At Birth", "status": "active", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile defines the minimum expectations for a [Person Recorded Sex or Gender extension](https://hl7.org/fhir/extensions/StructureDefinition-individual-recordedSexOrGender.html) when representing Sex Assigned at Birth. This profile identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Extension when conforming to this profile.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}], "kind": "complex-type", "abstract": false, "context": [{"type": "element", "expression": "Patient"}, {"type": "element", "expression": "RelatedPerson"}, {"type": "element", "expression": "Person"}, {"type": "element", "expression": "Practitioner"}], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.2.0"}], "element": [{"id": "Extension", "path": "Extension", "short": "Sex Assigned at Birth", "definition": "Sex assigned at birth refers to what was determined by biological sex characteristics including genital and chromosome composition observed at birth or infancy. Sex assigned at birth is captured once for a person and is not expected to change within their lifetime.", "comment": "A person's sex can change over the course of their lifetime. The value in sex assigned at birth may not match a person\u2019s gender or the sex recorded on their birth certificate or values in observations taken later in life that are the result of a specific measurement e.g. gonadal, ductal or phenotypic.", "alias": ["Birth sex", "Natal sex"], "min": 0, "max": "*", "base": {"path": "Extension", "min": 0, "max": "*"}, "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false}, {"id": "Extension.id", "path": "Extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension", "path": "Extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 2, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:value", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Extension.extension", "sliceName": "value", "short": "Extension", "definition": "An Extension", "min": 1, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "mustSupport": true, "isModifier": false, "isSummary": false}, {"id": "Extension.extension:value.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:value.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:value.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "value", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:value.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1"}, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:type", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Extension.extension", "sliceName": "type", "short": "SNOMED Sex Assigned at Birth", "definition": "The type or category of sex or gender that is recorded is sex assigned at birth.", "comment": "Because the recorded sex or gender concept exists primarily as means to exchange sex and gender data concepts that are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, the type is used to identify what type of concept the recorded sex or gender concept is.", "min": 1, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "mustSupport": true, "isModifier": false, "isSummary": false}, {"id": "Extension.extension:type.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:type.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:type.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "type", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:type.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "patternCodeableConcept": {"coding": [{"system": "http://snomed.info/sct", "code": "1515311000168102"}]}, "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "recordedSexOrGenderType"}], "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type"}, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:effectivePeriod", "path": "Extension.extension", "sliceName": "effectivePeriod", "short": "When the recorded sex or gender value applies", "definition": "The time period during which the recorded sex or gender value applies to the individual", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:effectivePeriod.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:effectivePeriod.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:effectivePeriod.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "effectivePeriod", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:effectivePeriod.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 0, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "Period"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:acquisitionDate", "path": "Extension.extension", "sliceName": "acquisitionDate", "short": "When the sex or gender value was recorded.", "definition": "The date/time when the sex or gender value was first recorded in the system.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:acquisitionDate.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:acquisitionDate.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:acquisitionDate.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "acquisitionDate", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:acquisitionDate.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "dateTime"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:source", "path": "Extension.extension", "sliceName": "source", "short": "The source of the Recorded Sex or Gender value.", "definition": "A reference to the source of the Recorded Sex or Gender value.", "comment": "Unlike the sourceDocument element, this element can reference non-document sources including applications, organisations or individuals. For example, if the Recored Sex or Gender value is recorded in a national patient identifier system this element may reference that system. This element can also be the source of the document referred to in the sourceDocument element. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:source.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:source.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:source.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "source", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:source.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}, {"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Practitioner"]}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:sourceDocument", "path": "Extension.extension", "sliceName": "sourceDocument", "short": "The document the sex or gender property was acquired from.", "definition": "The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.", "comment": "For example, if a driver's license is scanned, this property may reference that scanned document. If values for sourceDocument and source are both present, then the sourceDocument may be assumed to have originated from the source e.g. a clinical document in an electronic health record system.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:sourceDocument.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:sourceDocument.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:sourceDocument.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "sourceDocument", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:sourceDocument.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}, {"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/DocumentReference"]}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:sourceField", "path": "Extension.extension", "sliceName": "sourceField", "short": "The name of the field within the source document where this sex or gender property is initially recorded.", "definition": "The name of the field within the source document where this sex or gender property is initially recorded.", "comment": "For example, if a sex value is acquired from a driver's license, and the name of the field on that driver's license is 'SEX', then a code describing that field can be provided.  If the semantics of the field are known, they may be described in the comment.  For example, if the 'SEX' field on a license in a particular state or province is populated based on an individual's indication of what gender they consider themselves to be, but the field label is 'SEX' for historical reasons, a comment describing that the semantics of the field align with gender identity, even though the field name is 'SEX' can be provided.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:sourceField.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:sourceField.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:sourceField.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "sourceField", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:sourceField.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "string"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:jurisdiction", "path": "Extension.extension", "sliceName": "jurisdiction", "short": "Who issued the document where the sex or gender was aquired", "definition": "Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.", "comment": "For example, a individual's driver's license or passport would be issued by a specific state or country.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:jurisdiction.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:jurisdiction.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:jurisdiction.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "jurisdiction", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:jurisdiction.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Jurisdiction ValueSet"}], "strength": "extensible", "valueSet": "http://terminology.hl7.org/ValueSet/jurisdiction"}, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:comment", "path": "Extension.extension", "sliceName": "comment", "short": "Context or source information about the recorded sex or gender", "definition": "Further explanation about the context or source of the recorded sex or gender value", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:comment.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:comment.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:comment.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "comment", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:comment.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "string"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:genderElementQualifier", "path": "Extension.extension", "sliceName": "genderElementQualifier", "short": "Whether this recorded sex or gender value qualifies the .gender element.", "definition": "Instances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource.  For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context.", "min": 0, "max": "1", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:genderElementQualifier.id", "path": "Extension.extension.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "condition": ["ele-1"], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Extension.extension:genderElementQualifier.extension", "path": "Extension.extension.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false}, {"id": "Extension.extension:genderElementQualifier.url", "path": "Extension.extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "genderElementQualifier", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.extension:genderElementQualifier.value[x]", "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 1, "max": "1", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.url", "path": "Extension.url", "representation": ["xmlAttr"], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min": 1, "max": "1", "base": {"path": "Extension.url", "min": 1, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri"}], "code": "http://hl7.org/fhirpath/System.String"}], "fixedUri": "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender", "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Value of extension", "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).", "min": 0, "max": "0", "base": {"path": "Extension.value[x]", "min": 0, "max": "1"}, "type": [{"code": "base64Binary"}, {"code": "boolean"}, {"code": "canonical"}, {"code": "code"}, {"code": "date"}, {"code": "dateTime"}, {"code": "decimal"}, {"code": "id"}, {"code": "instant"}, {"code": "integer"}, {"code": "markdown"}, {"code": "oid"}, {"code": "positiveInt"}, {"code": "string"}, {"code": "time"}, {"code": "unsignedInt"}, {"code": "uri"}, {"code": "url"}, {"code": "uuid"}, {"code": "Address"}, {"code": "Age"}, {"code": "Annotation"}, {"code": "Attachment"}, {"code": "CodeableConcept"}, {"code": "Coding"}, {"code": "ContactPoint"}, {"code": "Count"}, {"code": "Distance"}, {"code": "Duration"}, {"code": "HumanName"}, {"code": "Identifier"}, {"code": "Money"}, {"code": "Period"}, {"code": "Quantity"}, {"code": "Range"}, {"code": "Ratio"}, {"code": "Reference"}, {"code": "SampledData"}, {"code": "Signature"}, {"code": "Timing"}, {"code": "ContactDetail"}, {"code": "DataRequirement"}, {"code": "Expression"}, {"code": "ParameterDefinition"}, {"code": "RelatedArtifact"}, {"code": "TriggerDefinition"}, {"code": "UsageContext"}, {"code": "Dosage"}, {"code": "Meta"}], "condition": ["ext-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}]}, "differential": {"element": [{"id": "Extension", "path": "Extension", "short": "Sex Assigned at Birth", "definition": "Sex assigned at birth refers to what was determined by biological sex characteristics including genital and chromosome composition observed at birth or infancy. Sex assigned at birth is captured once for a person and is not expected to change within their lifetime.", "comment": "A person's sex can change over the course of their lifetime. The value in sex assigned at birth may not match a person\u2019s gender or the sex recorded on their birth certificate or values in observations taken later in life that are the result of a specific measurement e.g. gonadal, ductal or phenotypic.", "alias": ["Birth sex", "Natal sex"]}, {"id": "Extension.extension:value", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Extension.extension", "sliceName": "value", "min": 1, "type": [{"code": "Extension"}], "mustSupport": true}, {"id": "Extension.extension:value.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [{"code": "CodeableConcept"}], "binding": {"strength": "extensible", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1"}}, {"id": "Extension.extension:type", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Extension.extension", "sliceName": "type", "short": "SNOMED Sex Assigned at Birth", "definition": "The type or category of sex or gender that is recorded is sex assigned at birth.", "comment": "Because the recorded sex or gender concept exists primarily as means to exchange sex and gender data concepts that are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, the type is used to identify what type of concept the recorded sex or gender concept is.", "min": 1, "max": "1", "type": [{"code": "Extension"}], "mustSupport": true}, {"id": "Extension.extension:type.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [{"code": "CodeableConcept"}], "patternCodeableConcept": {"coding": [{"system": "http://snomed.info/sct", "code": "1515311000168102"}]}}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


package_name: hl7.fhir.au.core-1.1.0
package_version: preview
resource_type: Observation
view: differential
structure_data:
{"structure_definition": {"resourceType": "StructureDefinition", "id": "au-core-waistcircum", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2}, {"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core"}]}}], "url": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum", "version": "1.1.0-preview", "name": "AUCoreWaistCircumference", "title": "AU Core Waist Circumference", "status": "active", "date": "2025-03-06T07:19:11+00:00", "publisher": "HL7 Australia", "contact": [{"name": "HL7 Australia FHIR Work Group", "telecom": [{"system": "url", "value": "https://confluence.hl7.org/display/HAFWG", "use": "work"}]}], "description": "This profile sets minimum expectations for an Observation resource to record, search, and fetch waist circumference observations with standard coding and units of measure. It is based on the [FHIR Vital Signs Profile](http://hl7.org/fhir/R4/vitalsigns.html) and identifies the *additional* mandatory core elements, extensions, vocabularies and value sets that **SHALL** be present in the Observation resource when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.", "jurisdiction": [{"coding": [{"system": "urn:iso:std:iso:3166", "code": "AU"}]}], "copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia\u00a9 2022+; Licensed Under Creative Commons No Rights Reserved.", "fhirVersion": "4.0.1", "mapping": [{"identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern"}, {"identity": "sct-concept", "uri": "http://snomed.info/conceptdomain", "name": "SNOMED CT Concept Domain Binding"}, {"identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping"}, {"identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping"}, {"identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping"}, {"identity": "sct-attr", "uri": "http://snomed.org/attributebinding", "name": "SNOMED CT Attribute Binding"}], "kind": "resource", "abstract": false, "type": "Observation", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/vitalsigns", "derivation": "constraint", "snapshot": {"extension": [{"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "4.0.1"}], "element": [{"id": "Observation", "path": "Observation", "short": "Waist circumference", "definition": "Measurement of a patient's waist circumference at a point in time.", "comment": "Waist circumference observation using a LOINC code, a SNOMED CT code and a metric UCUM unit of measure.", "alias": ["Vital Signs", "Measurement", "Results", "Tests"], "min": 0, "max": "*", "base": {"path": "Observation", "min": 0, "max": "*"}, "constraint": [{"key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."}], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource"}, {"key": "obs-6", "severity": "error", "human": "dataAbsentReason SHALL only be present if Observation.value[x] is not present", "expression": "dataAbsentReason.empty() or value.empty()", "xpath": "not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))", "source": "http://hl7.org/fhir/StructureDefinition/Observation"}, {"key": "obs-7", "severity": "error", "human": "If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present", "expression": "value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()", "xpath": "not(f:*[starts-with(local-name(.), 'value')] and (for $coding in f:code/f:coding return f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value] [f:system/@value=$coding/f:system/@value]))", "source": "http://hl7.org/fhir/StructureDefinition/Observation"}, {"key": "vs-2", "severity": "error", "human": "If there is no component or hasMember element then either a value[x] or a data absent reason must be present.", "expression": "(component.empty() and hasMember.empty()) implies (dataAbsentReason.exists() or value.exists())", "xpath": "f:component or f:memberOF or f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", "source": "http://hl7.org/fhir/StructureDefinition/vitalsigns"}, {"key": "au-core-obs-01", "severity": "error", "human": "At least value or data absent reason shall be present", "expression": "dataAbsentReason.exists() or value.exists()", "xpath": "exists(f:*[starts-with(local-name(.), 'value')]) or exists(f:dataAbsentReason)", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Entity. Role, or Act"}, {"identity": "workflow", "map": "Event"}, {"identity": "sct-concept", "map": "< 363787002 |Observable entity|"}, {"identity": "v2", "map": "OBX"}, {"identity": "rim", "map": "Observation[classCode=OBS, moodCode=EVN]"}]}, {"id": "Observation.id", "path": "Observation.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": {"path": "Resource.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": true}, {"id": "Observation.meta", "path": "Observation.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": {"path": "Resource.meta", "min": 0, "max": "1"}, "type": [{"code": "Meta"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true}, {"id": "Observation.implicitRules", "path": "Observation.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": {"path": "Resource.implicitRules", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true}, {"id": "Observation.language", "path": "Observation.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": {"path": "Resource.language", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"}, {"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language"}], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages"}}, {"id": "Observation.text", "path": "Observation.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": ["narrative", "html", "xhtml", "display"], "min": 0, "max": "1", "base": {"path": "DomainResource.text", "min": 0, "max": "1"}, "type": [{"code": "Narrative"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "Act.text?"}]}, {"id": "Observation.contained", "path": "Observation.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": ["inline resources", "anonymous resources", "contained resources"], "min": 0, "max": "*", "base": {"path": "DomainResource.contained", "min": 0, "max": "*"}, "type": [{"code": "Resource"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Observation.extension", "path": "Observation.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Observation.modifierExtension", "path": "Observation.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "DomainResource.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Observation.identifier", "path": "Observation.identifier", "short": "Business Identifier for observation", "definition": "A unique identifier assigned to this observation.", "requirements": "Allows observations to be distinguished and referenced.", "min": 0, "max": "*", "base": {"path": "Observation.identifier", "min": 0, "max": "*"}, "type": [{"code": "Identifier"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.identifier"}, {"identity": "w5", "map": "FiveWs.identifier"}, {"identity": "v2", "map": "OBX.21  For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4."}, {"identity": "rim", "map": "id"}]}, {"id": "Observation.basedOn", "path": "Observation.basedOn", "short": "Fulfills plan, proposal or order", "definition": "A plan, proposal or order that is fulfilled in whole or in part by this event.  For example, a MedicationRequest may require a patient to have laboratory test performed before  it is dispensed.", "requirements": "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "alias": ["Fulfills"], "min": 0, "max": "*", "base": {"path": "Observation.basedOn", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/ServiceRequest"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.basedOn"}, {"identity": "v2", "map": "ORC"}, {"identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=EVN]"}]}, {"id": "Observation.partOf", "path": "Observation.partOf", "short": "Part of referenced event", "definition": "A larger event of which this particular Observation is a component or step.  For example,  an observation as part of a procedure.", "comment": "To link an Observation to an Encounter use `encounter`.  See the  [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below for guidance on referencing another Observation.", "alias": ["Container"], "min": 0, "max": "*", "base": {"path": "Observation.partOf", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/MedicationStatement", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Immunization", "http://hl7.org/fhir/StructureDefinition/ImagingStudy"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.partOf"}, {"identity": "v2", "map": "Varies by domain"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target"}]}, {"id": "Observation.status", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-display-hint", "valueString": "default: final"}, {"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.status", "short": "registered | preliminary | final | amended +", "definition": "The status of the result value.", "comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "requirements": "Need to track the status of individual results. Some results are finalized before the whole report is finalized.", "min": 1, "max": "1", "base": {"path": "Observation.status", "min": 1, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": true, "isModifierReason": "This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Status"}], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/observation-status|4.0.1"}, "mapping": [{"identity": "workflow", "map": "Event.status"}, {"identity": "w5", "map": "FiveWs.status"}, {"identity": "sct-concept", "map": "< 445584004 |Report by finality status|"}, {"identity": "v2", "map": "OBX-11"}, {"identity": "rim", "map": "status  Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of \"revise\""}]}, {"id": "Observation.category", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category", "slicing": {"discriminator": [{"type": "value", "path": "coding.code"}, {"type": "value", "path": "coding.system"}], "ordered": false, "rules": "open"}, "short": "Classification of  type of observation", "definition": "A code that classifies the general type of observation being made.", "comment": "In addition to the required category valueset, this element allows various categorization schemes based on the owner\u2019s definition of the category and effectively multiple categories can be used at once.  The level of granularity is defined by the category concepts in the value set.", "requirements": "Used for filtering what observations are retrieved and displayed.", "min": 1, "max": "*", "base": {"path": "Observation.category", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory"}], "strength": "preferred", "description": "Codes for high level observation categories.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category"}, "mapping": [{"identity": "w5", "map": "FiveWs.class"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]}, {"id": "Observation.category:VSCat", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category", "sliceName": "VSCat", "short": "Classification of  type of observation", "definition": "A code that classifies the general type of observation being made.", "comment": "In addition to the required category valueset, this element allows various categorization schemes based on the owner\u2019s definition of the category and effectively multiple categories can be used at once.  The level of granularity is defined by the category concepts in the value set.", "requirements": "Used for filtering what observations are retrieved and displayed.", "min": 1, "max": "1", "base": {"path": "Observation.category", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationCategory"}], "strength": "preferred", "description": "Codes for high level observation categories.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-category"}, "mapping": [{"identity": "w5", "map": "FiveWs.class"}, {"identity": "rim", "map": ".outboundRelationship[typeCode=\"COMP].target[classCode=\"LIST\", moodCode=\"EVN\"].code"}]}, {"id": "Observation.category:VSCat.id", "path": "Observation.category.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.category:VSCat.extension", "path": "Observation.category.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.category:VSCat.coding", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "max": "*", "base": {"path": "CodeableConcept.coding", "min": 0, "max": "*"}, "type": [{"code": "Coding"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1-8, C*E.10-22"}, {"identity": "rim", "map": "union(., ./translation)"}, {"identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]}, {"id": "Observation.category:VSCat.coding.id", "path": "Observation.category.coding.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.category:VSCat.coding.extension", "path": "Observation.category.coding.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.category:VSCat.coding.system", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...).  OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": {"path": "Coding.system", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.3"}, {"identity": "rim", "map": "./codeSystem"}, {"identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]}, {"id": "Observation.category:VSCat.coding.version", "path": "Observation.category.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": {"path": "Coding.version", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.7"}, {"identity": "rim", "map": "./codeSystemVersion"}, {"identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]}, {"id": "Observation.category:VSCat.coding.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": {"path": "Coding.code", "min": 0, "max": "1"}, "type": [{"code": "code"}], "fixedCode": "vital-signs", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1"}, {"identity": "rim", "map": "./code"}, {"identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]}, {"id": "Observation.category:VSCat.coding.display", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.category.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.", "min": 0, "max": "1", "base": {"path": "Coding.display", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.2 - but note this is not well followed"}, {"identity": "rim", "map": "CV.displayName"}, {"identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]}, {"id": "Observation.category:VSCat.coding.userSelected", "path": "Observation.category.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": {"path": "Coding.userSelected", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "Sometimes implied by being first"}, {"identity": "rim", "map": "CD.codingRationale"}, {"identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;   fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [     fhir:source \"true\";     fhir:target dt:CDCoding.codingRationale\\#O   ]"}]}, {"id": "Observation.category:VSCat.text", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.category.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": {"path": "CodeableConcept.text", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this"}, {"identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data"}, {"identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]}, {"id": "Observation.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.code", "short": "Coded Responses from C-CDA Vital Sign Results", "definition": "Coded Responses from C-CDA Vital Sign Results.", "comment": "*All* code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "requirements": "5. SHALL contain exactly one [1..1] code, where the @code SHOULD be selected from ValueSet HITSP Vital Sign Result Type 2.16.840.1.113883.3.88.12.80.62 DYNAMIC (CONF:7301).", "alias": ["Name"], "min": 1, "max": "1", "base": {"path": "Observation.code", "min": 1, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns"}], "strength": "extensible", "description": "This identifies the vital sign result type.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult"}, "mapping": [{"identity": "workflow", "map": "Event.code"}, {"identity": "w5", "map": "FiveWs.what[x]"}, {"identity": "sct-concept", "map": "< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|"}, {"identity": "v2", "map": "OBX-3"}, {"identity": "rim", "map": "code"}, {"identity": "sct-attr", "map": "116680003 |Is a|"}]}, {"id": "Observation.code.id", "path": "Observation.code.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.extension", "path": "Observation.code.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.coding", "path": "Observation.code.coding", "slicing": {"discriminator": [{"type": "value", "path": "code"}, {"type": "value", "path": "system"}], "ordered": false, "rules": "open"}, "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 2, "max": "*", "base": {"path": "CodeableConcept.coding", "min": 0, "max": "*"}, "type": [{"code": "Coding"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1-8, C*E.10-22"}, {"identity": "rim", "map": "union(., ./translation)"}, {"identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]}, {"id": "Observation.code.coding:loincWaistCircumCode", "path": "Observation.code.coding", "sliceName": "loincWaistCircumCode", "short": "LOINC Waist Circumference", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "max": "1", "base": {"path": "CodeableConcept.coding", "min": 0, "max": "*"}, "type": [{"code": "Coding"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1-8, C*E.10-22"}, {"identity": "rim", "map": "union(., ./translation)"}, {"identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.id", "path": "Observation.code.coding.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.extension", "path": "Observation.code.coding.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.system", "path": "Observation.code.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...).  OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": {"path": "Coding.system", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "http://loinc.org", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.3"}, {"identity": "rim", "map": "./codeSystem"}, {"identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.version", "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": {"path": "Coding.version", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.7"}, {"identity": "rim", "map": "./codeSystemVersion"}, {"identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.code", "path": "Observation.code.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": {"path": "Coding.code", "min": 0, "max": "1"}, "type": [{"code": "code"}], "fixedCode": "8280-0", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1"}, {"identity": "rim", "map": "./code"}, {"identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.display", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.code.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.", "min": 0, "max": "1", "base": {"path": "Coding.display", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.2 - but note this is not well followed"}, {"identity": "rim", "map": "CV.displayName"}, {"identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]}, {"id": "Observation.code.coding:loincWaistCircumCode.userSelected", "path": "Observation.code.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": {"path": "Coding.userSelected", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "Sometimes implied by being first"}, {"identity": "rim", "map": "CD.codingRationale"}, {"identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;   fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [     fhir:source \"true\";     fhir:target dt:CDCoding.codingRationale\\#O   ]"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode", "path": "Observation.code.coding", "sliceName": "snomedWaistCircumCode", "short": "SNOMED CT Waist Circumference", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.  Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 1, "max": "1", "base": {"path": "CodeableConcept.coding", "min": 0, "max": "*"}, "type": [{"code": "Coding"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1-8, C*E.10-22"}, {"identity": "rim", "map": "union(., ./translation)"}, {"identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.id", "path": "Observation.code.coding.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.extension", "path": "Observation.code.coding.extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.system", "path": "Observation.code.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...).  OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": {"path": "Coding.system", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "http://snomed.info/sct", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.3"}, {"identity": "rim", "map": "./codeSystem"}, {"identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.version", "path": "Observation.code.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": {"path": "Coding.version", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.7"}, {"identity": "rim", "map": "./codeSystemVersion"}, {"identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.code", "path": "Observation.code.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": {"path": "Coding.code", "min": 0, "max": "1"}, "type": [{"code": "code"}], "fixedCode": "276361009", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.1"}, {"identity": "rim", "map": "./code"}, {"identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.display", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.code.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.", "min": 0, "max": "1", "base": {"path": "Coding.display", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.2 - but note this is not well followed"}, {"identity": "rim", "map": "CV.displayName"}, {"identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"}]}, {"id": "Observation.code.coding:snomedWaistCircumCode.userSelected", "path": "Observation.code.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": {"path": "Coding.userSelected", "min": 0, "max": "1"}, "type": [{"code": "boolean"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "Sometimes implied by being first"}, {"identity": "rim", "map": "CD.codingRationale"}, {"identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map;   fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [     fhir:source \"true\";     fhir:target dt:CDCoding.codingRationale\\#O   ]"}]}, {"id": "Observation.code.text", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.code.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": {"path": "CodeableConcept.text", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this"}, {"identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data"}, {"identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"}]}, {"id": "Observation.subject", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.subject", "short": "Who and/or what the observation is about", "definition": "The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation.", "comment": "One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated.", "requirements": "Observations have no value if you don't know who or what they're about.", "min": 1, "max": "1", "base": {"path": "Observation.subject", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.subject"}, {"identity": "w5", "map": "FiveWs.subject[x]"}, {"identity": "v2", "map": "PID-3"}, {"identity": "rim", "map": "participation[typeCode=RTGT]"}, {"identity": "w5", "map": "FiveWs.subject"}]}, {"id": "Observation.focus", "path": "Observation.focus", "short": "What the observation is about, when it is not about the subject of record", "definition": "The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record.  The focus of an observation could also be an existing condition,  an intervention, the subject's diet,  another observation of the subject,  or a body structure such as tumor or implanted device.   An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.", "comment": "Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., \"Blood Glucose\") and does not need to be represented separately using this element.  Use `specimen` if a reference to a specimen is required.  If a code is required instead of a resource use either  `bodysite` for bodysites or the standard extension [focusCode](http://hl7.org/fhir/extension-observation-focuscode.html).", "min": 0, "max": "*", "base": {"path": "Observation.focus", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Resource"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.subject[x]"}, {"identity": "v2", "map": "OBX-3"}, {"identity": "rim", "map": "participation[typeCode=SBJ]"}, {"identity": "w5", "map": "FiveWs.subject"}]}, {"id": "Observation.encounter", "path": "Observation.encounter", "short": "Healthcare event during which this observation is made", "definition": "The healthcare event  (e.g. a patient and healthcare provider interaction) during which this observation is made.", "comment": "This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests).", "requirements": "For some observations it may be important to know the link between an observation and a particular encounter.", "alias": ["Context"], "min": 0, "max": "1", "base": {"path": "Observation.encounter", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Encounter"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.context"}, {"identity": "w5", "map": "FiveWs.context"}, {"identity": "v2", "map": "PV1"}, {"identity": "rim", "map": "inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]"}]}, {"id": "Observation.effective[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.effective[x]", "short": "Date, and optionally time, the observation was performed", "definition": "Date, and optionally time, the observation was performed.", "comment": "At least a date should be present unless this observation is a historical report.  For recording imprecise or \"fuzzy\" times (For example, a blood glucose measurement taken \"after breakfast\") use the [Timing](http://hl7.org/fhir/datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.", "requirements": "Knowing when an observation was deemed true is important to its relevance as well as determining trends.", "alias": ["Occurrence"], "min": 1, "max": "1", "base": {"path": "Observation.effective[x]", "min": 0, "max": "1"}, "type": [{"code": "dateTime"}], "condition": ["vs-1"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "vs-1", "severity": "error", "human": "if Observation.effective[x] is dateTime and has a value then that value shall be precise to the day", "expression": "$this is dateTime implies $this.toString().length() >= 10", "xpath": "f:effectiveDateTime[matches(@value, '^\\d{4}-\\d{2}-\\d{2}')]", "source": "http://hl7.org/fhir/StructureDefinition/vitalsigns"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.occurrence[x]"}, {"identity": "w5", "map": "FiveWs.done[x]"}, {"identity": "v2", "map": "OBX-14, and/or OBX-19 after v2.4  (depends on who observation made)"}, {"identity": "rim", "map": "effectiveTime"}]}, {"id": "Observation.issued", "path": "Observation.issued", "short": "Date/Time this version was made available", "definition": "The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.", "comment": "For Observations that don\u2019t require review and verification, it may be the same as the [`lastUpdated` ](http://hl7.org/fhir/resource-definitions.html#Meta.lastUpdated) time of the resource itself.  For Observations that do require review and verification for certain updates, it might not be the same as the `lastUpdated` time of the resource itself due to a non-clinically significant update that doesn\u2019t require the new version to be reviewed and verified again.", "min": 0, "max": "1", "base": {"path": "Observation.issued", "min": 0, "max": "1"}, "type": [{"code": "instant"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "w5", "map": "FiveWs.recorded"}, {"identity": "v2", "map": "OBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)"}, {"identity": "rim", "map": "participation[typeCode=AUT].time"}]}, {"id": "Observation.performer", "path": "Observation.performer", "short": "Who is responsible for the observation", "definition": "Who was responsible for asserting the observed value as \"true\".", "requirements": "May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.", "min": 0, "max": "*", "base": {"path": "Observation.performer", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "workflow", "map": "Event.performer.actor"}, {"identity": "w5", "map": "FiveWs.actor"}, {"identity": "v2", "map": "OBX.15 / (Practitioner)  OBX-16,  PRT-5:PRT-4='RO' /  (Device)  OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization)  OBX-23,  PRT-8:PRT-4='PO'"}, {"identity": "rim", "map": "participation[typeCode=PRF]"}]}, {"id": "Observation.value[x]", "path": "Observation.value[x]", "slicing": {"discriminator": [{"type": "type", "path": "$this"}], "ordered": false, "rules": "open"}, "short": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "comment": "An observation may have; 1)  a single value here, 2)  both a value and a set of related or component values,  or 3)  only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code.  A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value.  For additional guidance, see the [Notes section](http://hl7.org/fhir/observation.html#notes) below.", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "min": 0, "max": "1", "base": {"path": "Observation.value[x]", "min": 0, "max": "1"}, "type": [{"code": "Quantity"}, {"code": "CodeableConcept"}, {"code": "string"}, {"code": "boolean"}, {"code": "integer"}, {"code": "Range"}, {"code": "Ratio"}, {"code": "SampledData"}, {"code": "time"}, {"code": "dateTime"}, {"code": "Period"}], "condition": ["obs-7", "vs-2"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "sct-concept", "map": "< 441742003 |Evaluation finding|"}, {"identity": "v2", "map": "OBX.2, OBX.5, OBX.6"}, {"identity": "rim", "map": "value"}, {"identity": "sct-attr", "map": "363714003 |Interprets|"}]}, {"id": "Observation.value[x]:valueQuantity", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.value[x]", "sliceName": "valueQuantity", "short": "Waist circumference", "definition": "Vital Signs value are recorded using the Quantity data type. For supporting observations such as Cuff size could use other datatypes such as CodeableConcept.", "comment": "An observation may have; 1)  a single value here, 2)  both a value and a set of related or component values,  or 3)  only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code.  A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value.  For additional guidance, see the [Notes section](http://hl7.org/fhir/observation.html#notes) below.", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "min": 0, "max": "1", "base": {"path": "Observation.value[x]", "min": 0, "max": "1"}, "type": [{"code": "Quantity"}], "condition": ["obs-7", "vs-2", "au-core-obs-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "sct-concept", "map": "< 441742003 |Evaluation finding|"}, {"identity": "v2", "map": "OBX.2, OBX.5, OBX.6"}, {"identity": "rim", "map": "value"}, {"identity": "sct-attr", "map": "363714003 |Interprets|"}]}, {"id": "Observation.value[x]:valueQuantity.id", "path": "Observation.value[x].id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.value[x]:valueQuantity.extension", "path": "Observation.value[x].extension", "slicing": {"discriminator": [{"type": "value", "path": "url"}], "description": "Extensions are always sliced by (at least) url", "rules": "open"}, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.value[x]:valueQuantity.value", "path": "Observation.value[x].value", "short": "Numerical value (with implicit precision)", "definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.", "comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).", "requirements": "Precision is handled implicitly in almost all cases of measurement.", "min": 1, "max": "1", "base": {"path": "Quantity.value", "min": 0, "max": "1"}, "type": [{"code": "decimal"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "SN.2  / CQ - N/A"}, {"identity": "rim", "map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"}]}, {"id": "Observation.value[x]:valueQuantity.comparator", "path": "Observation.value[x].comparator", "short": "< | <= | >= | > - how to understand the value", "definition": "How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is \"<\" , then the real value is < stated value.", "requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.", "min": 0, "max": "1", "base": {"path": "Quantity.comparator", "min": 0, "max": "1"}, "type": [{"code": "code"}], "meaningWhenMissing": "If there is no comparator, then there is no modification of the value", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value", "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "QuantityComparator"}], "strength": "required", "description": "How the Quantity should be understood and represented.", "valueSet": "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1"}, "mapping": [{"identity": "v2", "map": "SN.1  / CQ.1"}, {"identity": "rim", "map": "IVL properties"}]}, {"id": "Observation.value[x]:valueQuantity.unit", "extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true}], "path": "Observation.value[x].unit", "short": "Unit representation", "definition": "A human-readable form of the unit.", "requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.", "min": 1, "max": "1", "base": {"path": "Quantity.unit", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "(see OBX.6 etc.) / CQ.2"}, {"identity": "rim", "map": "PQ.unit"}]}, {"id": "Observation.value[x]:valueQuantity.system", "path": "Observation.value[x].system", "short": "System that defines coded unit form", "definition": "The identification of the system that provides the coded form of the unit.", "requirements": "Need to know the system that defines the coded form of the unit.", "min": 1, "max": "1", "base": {"path": "Quantity.system", "min": 0, "max": "1"}, "type": [{"code": "uri"}], "fixedUri": "http://unitsofmeasure.org", "condition": ["qty-3"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "(see OBX.6 etc.) / CQ.2"}, {"identity": "rim", "map": "CO.codeSystem, PQ.translation.codeSystem"}]}, {"id": "Observation.value[x]:valueQuantity.code", "path": "Observation.value[x].code", "short": "Coded responses from the common UCUM units for vital signs value set.", "definition": "Coded responses from the common UCUM units for vital signs value set.", "comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency.  The context of use may additionally require a code from a particular system.", "requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.", "min": 1, "max": "1", "base": {"path": "Quantity.code", "min": 0, "max": "1"}, "type": [{"code": "code"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "binding": {"extension": [{"extension": [{"url": "purpose", "valueCode": "candidate"}, {"url": "valueSet", "valueCanonical": "https://healthterminologies.gov.au/fhir/ValueSet/metric-body-length-units-1"}, {"url": "documentation", "valueMarkdown": "For when metric units are preferred."}], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"}], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodylength"}, "mapping": [{"identity": "v2", "map": "(see OBX.6 etc.) / CQ.2"}, {"identity": "rim", "map": "PQ.code, MO.currency, PQ.translation.code"}]}, {"id": "Observation.dataAbsentReason", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.dataAbsentReason", "short": "Why the result is missing", "definition": "Provides a reason why the expected value in the element Observation.value[x] is missing.", "comment": "Null or exceptional values can be represented two ways in FHIR Observations.  One way is to simply include them in the value set and represent the exceptions in the value.  For example, measurement values for a serology test could be  \"detected\", \"not detected\", \"inconclusive\", or  \"specimen unsatisfactory\".   \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values.  For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0.  Because of these options, use-case agreements are required to interpret general observations for null or exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "base": {"path": "Observation.dataAbsentReason", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "condition": ["obs-6", "vs-2", "au-core-obs-01"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason"}], "strength": "extensible", "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason"}, "mapping": [{"identity": "v2", "map": "N/A"}, {"identity": "rim", "map": "value.nullFlavor"}]}, {"id": "Observation.interpretation", "path": "Observation.interpretation", "short": "High, low, normal, etc.", "definition": "A categorical assessment of an observation value.  For example, high, low, normal.", "comment": "Historically used for laboratory results (known as 'abnormal flag' ),  its use extends to other use cases where coded interpretations  are relevant.  Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "alias": ["Abnormal Flag"], "min": 0, "max": "*", "base": {"path": "Observation.interpretation", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation"}], "strength": "extensible", "description": "Codes identifying interpretations of observations.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation"}, "mapping": [{"identity": "sct-concept", "map": "< 260245000 |Findings values|"}, {"identity": "v2", "map": "OBX-8"}, {"identity": "rim", "map": "interpretationCode"}, {"identity": "sct-attr", "map": "363713009 |Has interpretation|"}]}, {"id": "Observation.note", "path": "Observation.note", "short": "Comments about the observation", "definition": "Comments about the observation or the results.", "comment": "May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation.", "requirements": "Need to be able to provide free text additional information.", "min": 0, "max": "*", "base": {"path": "Observation.note", "min": 0, "max": "*"}, "type": [{"code": "Annotation"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "NTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)"}, {"identity": "rim", "map": "subjectOf.observationEvent[code=\"annotation\"].value"}]}, {"id": "Observation.bodySite", "path": "Observation.bodySite", "short": "Observed body part", "definition": "Indicates the site on the subject's body where the observation was made (i.e. the target site).", "comment": "Only used if not implicit in code found in Observation.code.  In many systems, this may be represented as a related observation instead of an inline component.   \n\nIf the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension[ bodySite](http://hl7.org/fhir/extension-bodysite.html).", "min": 0, "max": "1", "base": {"path": "Observation.bodySite", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "condition": ["au-core-obs-02"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "au-core-obs-02", "severity": "error", "human": "If a coded body site is provided, at least one coding shall be from SNOMED CT", "expression": "coding.exists() implies coding.where(system='http://snomed.info/sct').exists()", "xpath": "not(exists(f:coding/f:system)) or exists(f:coding/f:system[@value='http://snomed.info/sct'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum"}], "isModifier": false, "isSummary": false, "binding": {"strength": "preferred", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/body-site-1"}, "mapping": [{"identity": "sct-concept", "map": "< 123037004 |Body structure|"}, {"identity": "v2", "map": "OBX-20"}, {"identity": "rim", "map": "targetSiteCode"}, {"identity": "sct-attr", "map": "718497002 |Inherent location|"}]}, {"id": "Observation.method", "path": "Observation.method", "short": "How it was done", "definition": "Indicates the mechanism used to perform the observation.", "comment": "Only used if not implicit in code for Observation.code.", "requirements": "In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.", "min": 0, "max": "1", "base": {"path": "Observation.method", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationMethod"}], "strength": "example", "description": "Methods for simple observations.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-methods"}, "mapping": [{"identity": "v2", "map": "OBX-17"}, {"identity": "rim", "map": "methodCode"}]}, {"id": "Observation.specimen", "path": "Observation.specimen", "short": "Specimen used for this observation", "definition": "The specimen that was used when this observation was made.", "comment": "Should only be used if not implicit in code found in `Observation.code`.  Observations are not made on specimens themselves; they are made on a subject, but in many cases by the means of a specimen. Note that although specimens are often involved, they are not always tracked and reported explicitly. Also note that observation resources may be used in contexts that track the specimen explicitly (e.g. Diagnostic Report).", "min": 0, "max": "1", "base": {"path": "Observation.specimen", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Specimen"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "sct-concept", "map": "< 123038009 |Specimen|"}, {"identity": "v2", "map": "SPM segment"}, {"identity": "rim", "map": "participation[typeCode=SPC].specimen"}, {"identity": "sct-attr", "map": "704319004 |Inherent in|"}]}, {"id": "Observation.device", "path": "Observation.device", "short": "(Measurement) Device", "definition": "The device used to generate the observation data.", "comment": "Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway.  Such devices may be documented using the Provenance resource where relevant.", "min": 0, "max": "1", "base": {"path": "Observation.device", "min": 0, "max": "1"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceMetric"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "sct-concept", "map": "< 49062001 |Device|"}, {"identity": "v2", "map": "OBX-17 / PRT -10"}, {"identity": "rim", "map": "participation[typeCode=DEV]"}, {"identity": "sct-attr", "map": "424226004 |Using device|"}]}, {"id": "Observation.referenceRange", "path": "Observation.referenceRange", "short": "Provides guide for interpretation", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.  Multiple reference ranges are interpreted as an \"OR\".   In other words, to represent two distinct target populations, two `referenceRange` elements would be used.", "comment": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "base": {"path": "Observation.referenceRange", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "obs-3", "severity": "error", "human": "Must have at least a low or a high or text", "expression": "low.exists() or high.exists() or text.exists()", "xpath": "(exists(f:low) or exists(f:high)or exists(f:text))", "source": "http://hl7.org/fhir/StructureDefinition/vitalsigns"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX.7"}, {"identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}, {"id": "Observation.referenceRange.id", "path": "Observation.referenceRange.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.referenceRange.extension", "path": "Observation.referenceRange.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.referenceRange.modifierExtension", "path": "Observation.referenceRange.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Observation.referenceRange.low", "path": "Observation.referenceRange.low", "short": "Low Range, if relevant", "definition": "The value of the low bound of the reference range.  The low bound of the reference range endpoint is inclusive of the value (e.g.  reference range is >=5 - <=9). If the low bound is omitted,  it is assumed to be meaningless (e.g. reference range is <=2.3).", "min": 0, "max": "1", "base": {"path": "Observation.referenceRange.low", "min": 0, "max": "1"}, "type": [{"code": "Quantity", "profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}], "condition": ["obs-3"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX-7"}, {"identity": "rim", "map": "value:IVL_PQ.low"}]}, {"id": "Observation.referenceRange.high", "path": "Observation.referenceRange.high", "short": "High Range, if relevant", "definition": "The value of the high bound of the reference range.  The high bound of the reference range endpoint is inclusive of the value (e.g.  reference range is >=5 - <=9). If the high bound is omitted,  it is assumed to be meaningless (e.g. reference range is >= 2.3).", "min": 0, "max": "1", "base": {"path": "Observation.referenceRange.high", "min": 0, "max": "1"}, "type": [{"code": "Quantity", "profile": ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]}], "condition": ["obs-3"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX-7"}, {"identity": "rim", "map": "value:IVL_PQ.high"}]}, {"id": "Observation.referenceRange.type", "path": "Observation.referenceRange.type", "short": "Reference range qualifier", "definition": "Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.", "comment": "This SHOULD be populated if there is more than one range.  If this element is not present then the normal range is assumed.", "requirements": "Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc.,  - for proper interpretation.", "min": 0, "max": "1", "base": {"path": "Observation.referenceRange.type", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeMeaning"}], "strength": "preferred", "description": "Code for the meaning of a reference range.", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-meaning"}, "mapping": [{"identity": "sct-concept", "map": "< 260245000 |Findings values| OR  \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR  \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"}, {"identity": "v2", "map": "OBX-10"}, {"identity": "rim", "map": "interpretationCode"}]}, {"id": "Observation.referenceRange.appliesTo", "path": "Observation.referenceRange.appliesTo", "short": "Reference range population", "definition": "Codes to indicate the target population this reference range applies to.  For example, a reference range may be based on the normal population or a particular sex or race.  Multiple `appliesTo`  are interpreted as an \"AND\" of the target populations.  For example, to represent a target population of African American females, both a code of female and a code for African American would be used.", "comment": "This SHOULD be populated if there is more than one range.  If this element is not present then the normal population is assumed.", "requirements": "Need to be able to identify the target population for proper interpretation.", "min": 0, "max": "*", "base": {"path": "Observation.referenceRange.appliesTo", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationRangeType"}], "strength": "example", "description": "Codes identifying the population the reference range applies to.", "valueSet": "http://hl7.org/fhir/ValueSet/referencerange-appliesto"}, "mapping": [{"identity": "sct-concept", "map": "< 260245000 |Findings values| OR  \r< 365860008 |General clinical state finding| \rOR \r< 250171008 |Clinical history or observation findings| OR  \r< 415229000 |Racial group| OR \r< 365400002 |Finding of puberty stage| OR\r< 443938003 |Procedure carried out on subject|"}, {"identity": "v2", "map": "OBX-10"}, {"identity": "rim", "map": "interpretationCode"}]}, {"id": "Observation.referenceRange.age", "path": "Observation.referenceRange.age", "short": "Applicable age range, if relevant", "definition": "The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.", "requirements": "Some analytes vary greatly over age.", "min": 0, "max": "1", "base": {"path": "Observation.referenceRange.age", "min": 0, "max": "1"}, "type": [{"code": "Range"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "outboundRelationship[typeCode=PRCN].targetObservationCriterion[code=\"age\"].value"}]}, {"id": "Observation.referenceRange.text", "path": "Observation.referenceRange.text", "short": "Text based reference range in an observation", "definition": "Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation.  An example would be a reference value of \"Negative\" or a list or table of \"normals\".", "min": 0, "max": "1", "base": {"path": "Observation.referenceRange.text", "min": 0, "max": "1"}, "type": [{"code": "string"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX-7"}, {"identity": "rim", "map": "value:ST"}]}, {"id": "Observation.hasMember", "path": "Observation.hasMember", "short": "Used when reporting vital signs panel components", "definition": "Used when reporting vital signs panel components.", "comment": "When using this element, an observation will typically have either a value or a set of related resources, although both may be present in some cases.  For a discussion on the ways Observations can assembled in groups together, see [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below.  Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/questionnaireresponse.html)  into a final score and represent the score as an Observation.", "min": 0, "max": "*", "base": {"path": "Observation.hasMember", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "Relationships established by OBX-4 usage"}, {"identity": "rim", "map": "outBoundRelationship"}]}, {"id": "Observation.derivedFrom", "path": "Observation.derivedFrom", "short": "Related measurements the observation is made from", "definition": "The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.", "comment": "All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value.  The most common reference will be another Observation.  For a discussion on the ways Observations can assembled in groups together, see [Notes](http://hl7.org/fhir/observation.html#obsgrouping) below.", "min": 0, "max": "*", "base": {"path": "Observation.derivedFrom", "min": 0, "max": "*"}, "type": [{"code": "Reference", "targetProfile": ["http://hl7.org/fhir/StructureDefinition/DocumentReference", "http://hl7.org/fhir/StructureDefinition/ImagingStudy", "http://hl7.org/fhir/StructureDefinition/Media", "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse", "http://hl7.org/fhir/StructureDefinition/MolecularSequence", "http://hl7.org/fhir/StructureDefinition/vitalsigns"]}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "Relationships established by OBX-4 usage"}, {"identity": "rim", "map": ".targetObservation"}]}, {"id": "Observation.component", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component", "short": "Used when reporting systolic and diastolic blood pressure.", "definition": "Used when reporting systolic and diastolic blood pressure.", "comment": "For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/observation.html#notes) below.", "requirements": "Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable).   However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation.", "min": 0, "max": "*", "base": {"path": "Observation.component", "min": 0, "max": "*"}, "type": [{"code": "BackboneElement"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "vs-3", "severity": "error", "human": "If there is no a value a data absent reason must be present", "expression": "value.exists() or dataAbsentReason.exists()", "xpath": "f:*[starts-with(local-name(.), 'value')] or f:dataAbsentReason", "source": "http://hl7.org/fhir/StructureDefinition/vitalsigns"}], "mustSupport": true, "isModifier": false, "isSummary": true, "mapping": [{"identity": "v2", "map": "containment by OBX-4?"}, {"identity": "rim", "map": "outBoundRelationship[typeCode=COMP]"}]}, {"id": "Observation.component.id", "path": "Observation.component.id", "representation": ["xmlAttr"], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": {"path": "Element.id", "min": 0, "max": "1"}, "type": [{"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string"}], "code": "http://hl7.org/fhirpath/System.String"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.component.extension", "path": "Observation.component.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": ["extensions", "user content"], "min": 0, "max": "*", "base": {"path": "Element.extension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "rim", "map": "n/a"}]}, {"id": "Observation.component.modifierExtension", "path": "Observation.component.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/extensibility.html#modifierExtension).", "alias": ["extensions", "user content", "modifiers"], "min": 0, "max": "*", "base": {"path": "BackboneElement.modifierExtension", "min": 0, "max": "*"}, "type": [{"code": "Extension"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}, {"key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension"}], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [{"identity": "rim", "map": "N/A"}]}, {"id": "Observation.component.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.code", "short": "Type of component observation (code / type)", "definition": "Describes what was observed. Sometimes this is called the observation \"code\".", "comment": "*All* code-value and  component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.", "requirements": "Knowing what kind of observation is being made is essential to understanding the observation.", "min": 1, "max": "1", "base": {"path": "Observation.component.code", "min": 1, "max": "1"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSigns"}], "strength": "extensible", "description": "This identifies the vital sign result type.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-vitalsignresult"}, "mapping": [{"identity": "w5", "map": "FiveWs.what[x]"}, {"identity": "sct-concept", "map": "< 363787002 |Observable entity| OR \r< 386053000 |Evaluation procedure|"}, {"identity": "v2", "map": "OBX-3"}, {"identity": "rim", "map": "code"}]}, {"id": "Observation.component.value[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.value[x]", "short": "Vital Sign Value recorded with UCUM", "definition": "Vital Sign Value recorded with UCUM.", "comment": "Used when observation has a set of component observations. An observation may have both a value (e.g. an  Apgar score)  and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value.  For additional guidance, see the [Notes section](http://hl7.org/fhir/observation.html#notes) below.", "requirements": "9. SHALL contain exactly one [1..1] value with @xsi:type=\"PQ\" (CONF:7305).", "min": 0, "max": "1", "base": {"path": "Observation.component.value[x]", "min": 0, "max": "1"}, "type": [{"code": "Quantity"}, {"code": "CodeableConcept"}, {"code": "string"}, {"code": "boolean"}, {"code": "integer"}, {"code": "Range"}, {"code": "Ratio"}, {"code": "SampledData"}, {"code": "time"}, {"code": "dateTime"}, {"code": "Period"}], "condition": ["vs-3"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": true, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VitalSignsUnits"}], "strength": "extensible", "description": "Common UCUM units for recording Vital Signs.", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-vitals-common|4.0.1"}, "mapping": [{"identity": "sct-concept", "map": "363714003 |Interprets| < 441742003 |Evaluation finding|"}, {"identity": "v2", "map": "OBX.2, OBX.5, OBX.6"}, {"identity": "rim", "map": "value"}, {"identity": "sct-attr", "map": "363714003 |Interprets|"}]}, {"id": "Observation.component.dataAbsentReason", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.dataAbsentReason", "short": "Why the component result is missing", "definition": "Provides a reason why the expected value in the element Observation.component.value[x] is missing.", "comment": "\"Null\" or exceptional values can be represented two ways in FHIR Observations.  One way is to simply include them in the value set and represent the exceptions in the value.  For example, measurement values for a serology test could be  \"detected\", \"not detected\", \"inconclusive\", or  \"test not done\". \n\nThe alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values.  For example, the dataAbsentReason code \"error\" could be used when the measurement was not completed.  Because of these options, use-case agreements are required to interpret general observations for exceptional values.", "requirements": "For many results it is necessary to handle exceptional values in measurements.", "min": 0, "max": "1", "base": {"path": "Observation.component.dataAbsentReason", "min": 0, "max": "1"}, "type": [{"code": "CodeableConcept"}], "condition": ["obs-6", "vs-3"], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "mustSupport": true, "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationValueAbsentReason"}], "strength": "extensible", "description": "Codes specifying why the result (`Observation.value[x]`) is missing.", "valueSet": "http://hl7.org/fhir/ValueSet/data-absent-reason"}, "mapping": [{"identity": "v2", "map": "N/A"}, {"identity": "rim", "map": "value.nullFlavor"}]}, {"id": "Observation.component.interpretation", "path": "Observation.component.interpretation", "short": "High, low, normal, etc.", "definition": "A categorical assessment of an observation value.  For example, high, low, normal.", "comment": "Historically used for laboratory results (known as 'abnormal flag' ),  its use extends to other use cases where coded interpretations  are relevant.  Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result.", "requirements": "For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.", "alias": ["Abnormal Flag"], "min": 0, "max": "*", "base": {"path": "Observation.component.interpretation", "min": 0, "max": "*"}, "type": [{"code": "CodeableConcept"}], "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "binding": {"extension": [{"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ObservationInterpretation"}], "strength": "extensible", "description": "Codes identifying interpretations of observations.", "valueSet": "http://hl7.org/fhir/ValueSet/observation-interpretation"}, "mapping": [{"identity": "sct-concept", "map": "< 260245000 |Findings values|"}, {"identity": "v2", "map": "OBX-8"}, {"identity": "rim", "map": "interpretationCode"}, {"identity": "sct-attr", "map": "363713009 |Has interpretation|"}]}, {"id": "Observation.component.referenceRange", "path": "Observation.component.referenceRange", "short": "Provides guide for interpretation of component result", "definition": "Guidance on how to interpret the value by comparison to a normal or recommended range.", "comment": "Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties.", "requirements": "Knowing what values are considered \"normal\" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts.", "min": 0, "max": "*", "base": {"path": "Observation.component.referenceRange", "min": 0, "max": "*"}, "contentReference": "http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange", "constraint": [{"key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element"}], "isModifier": false, "isSummary": false, "mapping": [{"identity": "v2", "map": "OBX.7"}, {"identity": "rim", "map": "outboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]"}]}]}, "differential": {"element": [{"id": "Observation", "path": "Observation", "short": "Waist circumference", "definition": "Measurement of a patient's waist circumference at a point in time.", "comment": "Waist circumference observation using a LOINC code, a SNOMED CT code and a metric UCUM unit of measure.", "constraint": [{"key": "au-core-obs-01", "severity": "error", "human": "At least value or data absent reason shall be present", "expression": "dataAbsentReason.exists() or value.exists()", "xpath": "exists(f:*[starts-with(local-name(.), 'value')]) or exists(f:dataAbsentReason)", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum"}]}, {"id": "Observation.status", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.status"}, {"id": "Observation.category", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category"}, {"id": "Observation.category:VSCat", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category", "sliceName": "VSCat"}, {"id": "Observation.category:VSCat.coding", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding"}, {"id": "Observation.category:VSCat.coding.system", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding.system"}, {"id": "Observation.category:VSCat.coding.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.category.coding.code"}, {"id": "Observation.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.code"}, {"id": "Observation.code.coding", "path": "Observation.code.coding", "slicing": {"discriminator": [{"type": "value", "path": "code"}, {"type": "value", "path": "system"}], "ordered": false, "rules": "open"}, "min": 2}, {"id": "Observation.code.coding:loincWaistCircumCode", "path": "Observation.code.coding", "sliceName": "loincWaistCircumCode", "short": "LOINC Waist Circumference", "min": 1, "max": "1"}, {"id": "Observation.code.coding:loincWaistCircumCode.system", "path": "Observation.code.coding.system", "min": 1, "fixedUri": "http://loinc.org"}, {"id": "Observation.code.coding:loincWaistCircumCode.code", "path": "Observation.code.coding.code", "min": 1, "fixedCode": "8280-0"}, {"id": "Observation.code.coding:snomedWaistCircumCode", "path": "Observation.code.coding", "sliceName": "snomedWaistCircumCode", "short": "SNOMED CT Waist Circumference", "min": 1, "max": "1"}, {"id": "Observation.code.coding:snomedWaistCircumCode.system", "path": "Observation.code.coding.system", "min": 1, "fixedUri": "http://snomed.info/sct"}, {"id": "Observation.code.coding:snomedWaistCircumCode.code", "path": "Observation.code.coding.code", "min": 1, "fixedCode": "276361009"}, {"id": "Observation.subject", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.subject", "type": [{"code": "Reference", "targetProfile": ["http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient"]}]}, {"id": "Observation.effective[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.effective[x]", "short": "Date, and optionally time, the observation was performed", "definition": "Date, and optionally time, the observation was performed.", "type": [{"code": "dateTime"}]}, {"id": "Observation.valueQuantity", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.valueQuantity", "short": "Waist circumference", "condition": ["au-core-obs-01"]}, {"id": "Observation.valueQuantity.value", "path": "Observation.valueQuantity.value", "min": 1, "max": "1", "type": [{"code": "decimal"}]}, {"id": "Observation.valueQuantity.unit", "path": "Observation.valueQuantity.unit", "min": 1, "max": "1", "type": [{"code": "string"}]}, {"id": "Observation.valueQuantity.system", "path": "Observation.valueQuantity.system", "min": 1, "max": "1", "type": [{"code": "uri"}], "fixedUri": "http://unitsofmeasure.org"}, {"id": "Observation.valueQuantity.code", "path": "Observation.valueQuantity.code", "short": "Coded responses from the common UCUM units for vital signs value set.", "definition": "Coded responses from the common UCUM units for vital signs value set.", "min": 1, "max": "1", "type": [{"code": "code"}], "binding": {"extension": [{"extension": [{"url": "purpose", "valueCode": "candidate"}, {"url": "valueSet", "valueCanonical": "https://healthterminologies.gov.au/fhir/ValueSet/metric-body-length-units-1"}, {"url": "documentation", "valueMarkdown": "For when metric units are preferred."}], "url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"}], "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-bodylength"}}, {"id": "Observation.dataAbsentReason", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.dataAbsentReason", "condition": ["au-core-obs-01"]}, {"id": "Observation.bodySite", "path": "Observation.bodySite", "condition": ["au-core-obs-02"], "constraint": [{"key": "au-core-obs-02", "severity": "error", "human": "If a coded body site is provided, at least one coding shall be from SNOMED CT", "expression": "coding.exists() implies coding.where(system='http://snomed.info/sct').exists()", "xpath": "not(exists(f:coding/f:system)) or exists(f:coding/f:system[@value='http://snomed.info/sct'])", "source": "http://hl7.org.au/fhir/core/StructureDefinition/au-core-waistcircum"}], "binding": {"strength": "preferred", "valueSet": "https://healthterminologies.gov.au/fhir/ValueSet/body-site-1"}}, {"id": "Observation.component", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component"}, {"id": "Observation.component.code", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.code"}, {"id": "Observation.component.value[x]", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.value[x]"}, {"id": "Observation.component.dataAbsentReason", "extension": [{"extension": [{"url": "code", "valueCode": "SHALL:populate-if-known"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-responder"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}, {"extension": [{"url": "code", "valueCode": "SHALL:no-error"}, {"url": "actor", "valueCanonical": "http://hl7.org.au/fhir/core/ActorDefinition/au-core-actor-requester"}], "url": "http://hl7.org/fhir/StructureDefinition/obligation"}], "path": "Observation.component.dataAbsentReason"}]}}, "must_support_paths": [], "fallback_used": false, "source_package": "hl7.fhir.au.core-1.1.0#preview"}


