"Profile","Id","Path","Slice Name","Alias(s)","Label","Min","Max","Must Support?","Is Modifier?","Is Summary?","Type(s)","Short","Definition","Comments","Requirements","Default Value","Meaning When Missing","Fixed Value","Pattern","Example","Minimum Value","Maximum Value","Maximum Length","Binding Strength","Binding Description","Binding Value Set","Code","Slicing Discriminator","Slicing Description","Slicing Ordered","Slicing Rules","Base Path","Base Min","Base Max","Condition(s)","Constraint(s)"
"SDHRAllergyIntolerance","AllergyIntolerance","AllergyIntolerance","","Allergy
IntoleranceAdverse Reaction","",0,*,"","","","null {[]} {[]}
","Allergy or Intolerance (generally: Risk of adverse reaction to a substance)","Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.","Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.","","","","","","","","",,,,,"",,,,"AllergyIntolerance",0,*,"","ait-1:AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. {verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()}
ait-2:AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error {verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()}dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}dom-3: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 {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()}dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated {contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()}dom-5:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}code-or-note-required:The AllergyIntolerance resource must have at least one of 'code' or 'note'. {(code.exists() or note.exists())}"
"SDHRAllergyIntolerance","AllergyIntolerance.id","AllergyIntolerance.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.meta","AllergyIntolerance.meta","","","",1,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.id","AllergyIntolerance.meta.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.meta.extension","AllergyIntolerance.meta.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.versionId","AllergyIntolerance.meta.versionId","","","",0,1,"","","Y","id {[]} {[]}
","Version specific identifier","The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.","The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.","","","","","","","","",,,,,"",,,,"Meta.versionId",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.lastUpdated","AllergyIntolerance.meta.lastUpdated","","","",0,1,"","","Y","instant {[]} {[]}
","When the resource version last changed","When the resource last changed - e.g. when the version changed.","This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.","","","","","","","","",,,,,"",,,,"Meta.lastUpdated",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.source","AllergyIntolerance.meta.source","","","",1,1,"","","Y","uri {[]} {[]}
","Captures the source of the record - please see description for details","Captures the source of the record. This must contain the HPIFacilityID
                            e.g. https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A","In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. 

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.","","","","","","","","",,,,,"",,,,"Meta.source",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
hpi-location-url-format:Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A {matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')}"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.profile","AllergyIntolerance.meta.profile","","","",1,1,"","","Y","canonical {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1]]}
","Profiles this resource claims to conform to","A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).","It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.","","","","","","","","",,,,,"",,,,"Meta.profile",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.security","AllergyIntolerance.meta.security","","","",0,*,"","","Y","Coding {[]} {[]}
","Security Labels applied to this resource","Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.","The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"extensible","Security Labels from the Healthcare Privacy and Security Classification System.","http://hl7.org/fhir/ValueSet/security-labels|4.0.1","",,,,"Meta.security",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.meta.tag","AllergyIntolerance.meta.tag","","","",0,*,"","","Y","Coding {[]} {[]}
","Tag the resource with a code to indicate usability components of the resource","Tag the resource with a code to indicate usability components of the resource. This is used to indicate that the resource is important and, for example, should be highlighted in a user interface.","The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"preferred","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-resource-tags-valueset","",,,,"Meta.tag",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.implicitRules","AllergyIntolerance.implicitRules","","","",0,0,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.language","AllergyIntolerance.language","","","",0,0,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages|4.0.1","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.text","AllergyIntolerance.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.contained","AllergyIntolerance.contained","","inline resources
anonymous resourcescontained resources","",0,0,"","","","Resource {[]} {[]}
","Contained, inline Resources","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.extension","AllergyIntolerance.extension","","","",1,*,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","",,"open","DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.extension:ClientLastUpdated","AllergyIntolerance.extension","ClientLastUpdated","","",1,1,"","","","Extension {[CanonicalType[https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension]]} {[]}
","Client Last Updated","Extension to record the last time a resource was updated by the source system. When consuming applications are writing data to the SDHR API they can use this extension to record the `LastUpdated` timestamp in their system","","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.modifierExtension","AllergyIntolerance.modifierExtension","","","",0,0,"","Y","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier","AllergyIntolerance.identifier","","","",1,*,"","","Y","Identifier {[]} {[]}
","A local identifier MUST be added to this section. If used, system MUST be specified.","A local identifier MUST be added to this section. This can be used to correlate the SDHR resource with a local system identifier to perform updates.","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 a Person resource instance might share the same social insurance number.","Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers.","","","","","","","",,,,,"",,,,"AllergyIntolerance.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.id","AllergyIntolerance.identifier.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.extension","AllergyIntolerance.identifier.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.use","AllergyIntolerance.identifier.use","","","",0,1,"","Y","Y","code {[]} {[]}
","The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.","The purpose of this identifier.","Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.","Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.","","","","","","","",,"required","Identifies the purpose for this identifier, if known .","http://hl7.org/fhir/ValueSet/identifier-use|4.0.1","",,,,"Identifier.use",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.type","AllergyIntolerance.identifier.type","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","Description of identifier","A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.","This element deals only with general categories of identifiers.  It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.   Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.","Allows users to make use of identifiers when the identifier system is not known.","","","","","","","",,"extensible","A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.","http://hl7.org/fhir/ValueSet/identifier-type|4.0.1","",,,,"Identifier.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.system","AllergyIntolerance.identifier.system","","","",1,1,"","","Y","uri {[]} {[]}
","System for the local identifier. This MUST be consistent per PMS/Health Application","Establishes the namespace for the value - that is, a URL that describes a set values that are unique.","Identifier.system is always case sensitive.","There are many sets  of identifiers.  To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""http://www.acme.com/identifiers/patient""/>","","",,,,,"",,,,"Identifier.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.value","AllergyIntolerance.identifier.value","","","",1,1,"","","Y","string {[]} {[]}
","The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710","The portion of the identifier typically relevant to the user and which is unique within the context of the system.","If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.  The value's primary purpose is computational mapping.  As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.)  A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.","","","","","","<valueString xmlns=""http://hl7.org/fhir"" value=""123456""/>","","",,,,,"",,,,"Identifier.value",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.period","AllergyIntolerance.identifier.period","","","",0,1,"","","Y","Period {[]} {[]}
","Time period when id is/was valid for use","Time period during which identifier is/was valid for use.","","","","","","","","","",,,,,"",,,,"Identifier.period",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.identifier.assigner","AllergyIntolerance.identifier.assigner","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Organization that issued id (may be just text)","Organization that issued/manages the identifier.","The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.","","","","","","","","",,,,,"",,,,"Identifier.assigner",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.clinicalStatus","AllergyIntolerance.clinicalStatus","","","",0,1,"","Y","Y","CodeableConcept {[]} {[]}
","active | inactive | resolved","The clinical status of the allergy or intolerance.","Refer to [discussion](http://hl7.org/fhir/R4/extensibility.html#Special-Case) if clincalStatus is missing data.
The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.","","","","","","","","",,"required","The clinical status of the allergy or intolerance.","http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1","",,,,"AllergyIntolerance.clinicalStatus",0,1,"ait-1
ait-2","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.verificationStatus","AllergyIntolerance.verificationStatus","","","",0,1,"","Y","Y","CodeableConcept {[]} {[]}
","unconfirmed | confirmed | refuted | entered-in-error","Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).","The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.","","","","","","","","",,"required","Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.","http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1","",,,,"AllergyIntolerance.verificationStatus",0,1,"ait-1
ait-2","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.type","AllergyIntolerance.type","","Category
Class","",0,1,"","","Y","code {[]} {[]}
","allergy | intolerance - Underlying mechanism (if known)","Identification of the underlying physiological mechanism for the reaction risk.","Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term ""allergy"" is used rather generically and may overlap with the use of ""intolerance"" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.","","","","","","","","",,"required","Identification of the underlying physiological mechanism for a Reaction Risk.","http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1","",,,,"AllergyIntolerance.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.category","AllergyIntolerance.category","","Category
TypeReaction TypeClass","",0,*,"","","Y","code {[]} {[]}
","food | medication | environment | biologic","Category of the identified substance.","This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation.  When searching on category, consider the implications of AllergyIntolerance resources without a category.  For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned.  Refer to [search](http://hl7.org/fhir/R4/search.html) for more information on how to search category with a :missing modifier to get allergies that don't have a category.  Additionally, category should be used with caution because category can be subjective based on the sender.","","","","","","","","",,"required","Category of an identified substance associated with allergies or intolerances.","http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1","",,,,"AllergyIntolerance.category",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.criticality","AllergyIntolerance.criticality","","Severity
SeriousnessContra-indicationRisk","",0,1,"","","Y","code {[]} {[]}
","low | high | unable-to-assess","Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.","The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).  Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity.  Existing systems that are capturing both condition criticality and reaction severity may use the term ""severity"" to represent both.  Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent.","","","","","","","","",,"required","Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.","http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1","",,,,"AllergyIntolerance.criticality",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code","AllergyIntolerance.code","","Code
","",0,1,"","","Y","CodeableConcept {[]} {[]}
","Preferred - a SNOMED CT code or a NZMT code. When the intolerance is referring to a medication please use the NZMT codeset. When referring to another supstance, food etc. please use SNOMED.","Code for an allergy or intolerance statement (either a positive or a negated/excluded statement).  This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., ""Latex""), an allergy or intolerance condition (e.g., ""Latex allergy""), or a negated/excluded code for a specific substance or class (e.g., ""No latex allergy"") or a general or categorical negated statement (e.g.,  ""No known allergy"", ""No known drug allergies"").  Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.  If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.","It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text.

When a substance or product code is specified for the 'code' element, the ""default"" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product.  In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the ""Causative agent"" relationship.

The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements.  This extension provides the capability to make ""no known allergy"" (or ""no risk of adverse reaction"") statements regarding any coded substance/product (including cases when a pre-coordinated ""no allergy to x"" concept for that substance/product does not exist).  If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted.","","","","","","","","",,"preferred","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-code-valueset","",,,,"AllergyIntolerance.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.id","AllergyIntolerance.code.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.code.extension","AllergyIntolerance.code.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding","AllergyIntolerance.code.coding","","","",0,*,"","","Y","Coding {[]} {[]}
","Code defined by a terminology system","A reference to a code defined by a terminology system.","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.","Allows for alternative encodings within a code system, and translations to other code systems.","","","","","","","",,,,,"",,,,"CodeableConcept.coding",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.id","AllergyIntolerance.code.coding.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.extension","AllergyIntolerance.code.coding.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.system","AllergyIntolerance.code.coding.system","","","",0,1,"","","Y","uri {[]} {[]}
","Identity of the terminology system","The identification of the code system that defines the meaning of the symbol in the code.","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.","Need to be unambiguous about the source of the definition of the symbol.","","","","","","","",,,,,"",,,,"Coding.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.version","AllergyIntolerance.code.coding.version","","","",0,1,"","","Y","string {[]} {[]}
","Version of the system - if relevant","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.","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.","","","","","","","","",,,,,"",,,,"Coding.version",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.code","AllergyIntolerance.code.coding.code","","","",0,1,"","","Y","code {[]} {[]}
","Symbol in syntax defined by the system","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).","","Need to refer to a particular code in the system.","","","","","","","",,,,,"",,,,"Coding.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.display","AllergyIntolerance.code.coding.display","","","",0,1,"","","Y","string {[]} {[]}
","Representation defined by the system","A representation of the meaning of the code in the system, following the rules of the system.","","Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.","","","","","","","",,,,,"",,,,"Coding.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.coding.userSelected","AllergyIntolerance.code.coding.userSelected","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates that the value has been selected by a system user","This field is used to maintain the code as selected by the source systems end user. For example, where a patient management system uses local codes or a non-common code set to record a substance or allergen this field indicates that the value is as selected by the system user. Some level of clinical interpretation may be required.","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.","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.","","","","","","","",,,,,"",,,,"Coding.userSelected",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.code.text","AllergyIntolerance.code.text","","","",0,1,"","","Y","string {[]} {[]}
","Plain text representation of the concept","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.","Very often the text is the same as a displayName of one of the codings.","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.","","","","","","","",,,,,"",,,,"CodeableConcept.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.patient","AllergyIntolerance.patient","","Patient
","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1]]}
","Who the sensitivity is for","The patient who has the allergy or intolerance.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.patient",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.patient.id","AllergyIntolerance.patient.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.patient.extension","AllergyIntolerance.patient.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.patient.reference","AllergyIntolerance.patient.reference","","","",1,1,"","","Y","string {[]} {[]}
","Must be an absolute URL reference to the patient on the NHI system. See constraints for details.","A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.","Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure ""/[type]/[id]"" then it should be assumed that the reference is to a FHIR RESTful server.","","","","","","","","",,,,,"",,,,"Reference.reference",0,1,"ref-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
nhi-url-format:Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA {matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')}"
"SDHRAllergyIntolerance","AllergyIntolerance.patient.type","AllergyIntolerance.patient.type","","","",1,1,"","","Y","uri {[]} {[]}
","Type the reference refers to (e.g. ""Patient"")","The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. ""Patient"" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).","This element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""Patient""/>","","","",,"extensible","Aa resource (or, for logical models, the URI of the logical model).","http://hl7.org/fhir/ValueSet/resource-types|4.0.1","",,,,"Reference.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.patient.identifier","AllergyIntolerance.patient.identifier","","","",0,1,"","","Y","Identifier {[]} {[]}
","Logical reference, when literal reference is not known","An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.","When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. 

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).","","","","","","","","",,,,,"",,,,"Reference.identifier",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.patient.display","AllergyIntolerance.patient.display","","","",0,1,"","","Y","string {[]} {[]}
","Text alternative for the resource","Plain text narrative that identifies the resource in addition to the resource reference.","This is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.","","","","","","","","",,,,,"",,,,"Reference.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.encounter","AllergyIntolerance.encounter","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1]]}
","Encounter when the allergy or intolerance was asserted","The encounter when the allergy or intolerance was asserted.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.encounter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.onset[x]","AllergyIntolerance.onset[x]","","","",0,1,"","","","dateTime {[]} {[]}
Age {[]} {[]}Period {[]} {[]}Range {[]} {[]}string {[]} {[]}","When allergy or intolerance was identified","Estimated or actual date,  date-time, or age when allergy or intolerance was identified.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.onset[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.recordedDate","AllergyIntolerance.recordedDate","","","",0,1,"","","","dateTime {[]} {[]}
","Date first version of the resource instance was recorded","The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.recordedDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.recorder","AllergyIntolerance.recorder","","Author
","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1]]}
","Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA","Individual who recorded the record and takes responsibility for its content.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.recorder",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.asserter","AllergyIntolerance.asserter","","Source
Informant","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1]]}
","Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA","The source of the information about the allergy that is recorded.","The recorder takes responsibility for the content, but can reference the source from where they got it.","","","","","","","","",,,,,"",,,,"AllergyIntolerance.asserter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.lastOccurrence","AllergyIntolerance.lastOccurrence","","","",0,1,"","","","dateTime {[]} {[]}
","Date(/time) of last known occurrence of a reaction","Represents the date and/or time of the last known occurrence of a reaction event.","This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.","","","","","","","","",,,,,"",,,,"AllergyIntolerance.lastOccurrence",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.note","AllergyIntolerance.note","","","",0,*,"","","","Annotation {[]} {[]}
","Additional text not captured in other fields","Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.","For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and  AllergyIntolerance.event.notes.","","","","","","","","",,,,,"",,,,"AllergyIntolerance.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction","AllergyIntolerance.reaction","","","",0,*,"","","","BackboneElement {[]} {[]}
","Adverse Reaction Events linked to exposure to substance","Details about each adverse reaction event linked to exposure to the identified substance.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.reaction",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.id","AllergyIntolerance.reaction.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.extension","AllergyIntolerance.reaction.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.modifierExtension","AllergyIntolerance.reaction.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.substance","AllergyIntolerance.reaction.substance","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Specific substance or pharmaceutical product considered to be responsible for event","Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'.  If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.","Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible.  The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, ""penicillins""), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, ""amoxycillin""). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'.","","","","","","","","",,"example","Codes defining the type of the substance (including pharmaceutical products).","http://hl7.org/fhir/ValueSet/substance-code|4.0.1","",,,,"AllergyIntolerance.reaction.substance",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.manifestation","AllergyIntolerance.reaction.manifestation","","Symptoms
Signs","",1,*,"","","","CodeableConcept {[]} {[]}
","Clinical symptoms/signs associated with the Event","Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.","Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines.  Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.","","","","","","","","",,"preferred","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-allergyintolerance-manifestation-valueset","",,,,"AllergyIntolerance.reaction.manifestation",1,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.description","AllergyIntolerance.reaction.description","","Narrative
Text","",0,1,"","","","string {[]} {[]}
","Description of the event as a whole","Text description about the reaction as a whole, including details of the manifestation if required.","Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.","","","","","","","","",,,,,"",,,,"AllergyIntolerance.reaction.description",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.onset","AllergyIntolerance.reaction.onset","","","",0,1,"","","","dateTime {[]} {[]}
","Date(/time) when manifestations showed","Record of the date and/or time of the onset of the Reaction.","","","","","","","","","",,,,,"",,,,"AllergyIntolerance.reaction.onset",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.severity","AllergyIntolerance.reaction.severity","","","",0,1,"","","","code {[]} {[]}
","mild | moderate | severe (of event as a whole)","Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.","It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.","","","","","","","","",,"required","Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.","http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1","",,,,"AllergyIntolerance.reaction.severity",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.exposureRoute","AllergyIntolerance.reaction.exposureRoute","","","",0,1,"","","","CodeableConcept {[]} {[]}
","How the subject was exposed to the substance","Identification of the route by which the subject was exposed to the substance.","Coding of the route of exposure with a terminology should be used wherever possible.","","","","","","","","",,"example","A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.","http://hl7.org/fhir/ValueSet/route-codes|4.0.1","",,,,"AllergyIntolerance.reaction.exposureRoute",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRAllergyIntolerance","AllergyIntolerance.reaction.note","AllergyIntolerance.reaction.note","","","",0,*,"","","","Annotation {[]} {[]}
","Text about event not captured in other fields","Additional text about the adverse reaction event not captured in other fields.","Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.","","","","","","","","",,,,,"",,,,"AllergyIntolerance.reaction.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle","Bundle","","","",0,*,"","","","null {[]} {[]}
","Contains a collection of resources","A container for a collection of resources.","","","","","","","","","",,,,,"",,,,"Bundle",0,*,"","bdl-1:total only when a search or history {total.empty() or (type = 'searchset') or (type = 'history')}
bdl-2:entry.search only when a search {entry.search.empty() or (type = 'searchset')}bdl-3:entry.request mandatory for batch/transaction/history, otherwise prohibited {entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))}bdl-4:entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited {entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))}bdl-7:FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) {(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()}bdl-9:A document must have an identifier with a system and a value {type = 'document' implies (identifier.system.exists() and identifier.value.exists())}bdl-10:A document must have a date {type = 'document' implies (timestamp.hasValue())}bdl-11:A document must have a Composition as the first resource {type = 'document' implies entry.first().resource.is(Composition)}bdl-12:A message must have a MessageHeader as the first resource {type = 'message' implies entry.first().resource.is(MessageHeader)}one-patient-only:All Patient references in the bundle are the same (compares full reference strings). {entry.resource.descendants().where($this is Reference).reference.where(matches('(^|.*/)?Patient/[^/]+$')).exists() and entry.resource.descendants().where($this is Reference).reference.where(matches('(^|.*/)?Patient/[^/]+$')).distinct().count() = 1}no-participation-ops:Bundle entries MUST NOT invoke $participate or $hnz-participate. {entry.request.url.where($this.matches('[$](participate|hnz-participate)')).exists().not()}"
"SDHRBatchBundle","Bundle.id","Bundle.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRBatchBundle","Bundle.meta","Bundle.meta","","","",0,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.implicitRules","Bundle.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.language","Bundle.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages|4.0.1","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.identifier","Bundle.identifier","","","",0,1,"","","Y","Identifier {[]} {[]}
","Persistent identifier for the bundle","A persistent identifier for the bundle that won't change as a bundle is copied from server to server.","Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents  the .identifier SHALL be populated such that the .identifier is globally unique.","","","","","","","","",,,,,"",,,,"Bundle.identifier",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.type","Bundle.type","","","",1,1,"","","Y","code {[]} {[]}
","document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection","Indicates the purpose of this bundle - how it is intended to be used.","It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.","","","","<valueCode xmlns=""http://hl7.org/fhir"" value=""batch""/>","","","","",,"required","Indicates the purpose of a bundle - how it is intended to be used.","http://hl7.org/fhir/ValueSet/bundle-type|4.0.1","",,,,"Bundle.type",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.timestamp","Bundle.timestamp","","","",0,1,"","","Y","instant {[]} {[]}
","When the bundle was assembled","The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.","For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated.  

Usage:

* document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time
* message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message
* history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates
* searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query
* transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning

The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.","","","","","","","","",,,,,"",,,,"Bundle.timestamp",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.total","Bundle.total","","","",0,1,"","","Y","unsignedInt {[]} {[]}
","If search, the total number of matches","If a set of search matches, this is the total number of entries of type 'match' across all pages in the search.  It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.","Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.","","","","","","","","",,,,,"",,,,"Bundle.total",0,1,"bdl-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.link","Bundle.link","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Links related to this Bundle","A series of links that provide context to this bundle.","Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)). 

Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was [read](http://hl7.org/fhir/R4/http.html#read) directly.

This specification defines some specific uses of Bundle.link for [searching](http://hl7.org/fhir/R4/search.html#conformance) and [paging](http://hl7.org/fhir/R4/http.html#paging), but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific.","","","","","","","","",,,,,"",,,,"Bundle.link",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.link.id","Bundle.link.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRBatchBundle","Bundle.link.extension","Bundle.link.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.link.modifierExtension","Bundle.link.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.link.relation","Bundle.link.relation","","","",1,1,"","","Y","string {[]} {[]}
","See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1","A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).","","","","","","","","","",,,,,"",,,,"Bundle.link.relation",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.link.url","Bundle.link.url","","","",1,1,"","","Y","uri {[]} {[]}
","Reference details for the link","The reference details for the link.","","","","","","","","","",,,,,"",,,,"Bundle.link.url",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry","Bundle.entry","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Entry in the bundle - will have a resource or information","An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).","","","","","","","","","",,,,,"",,,,"Bundle.entry",0,*,"","bdl-5:must be a resource unless there's a request or response {resource.exists() or request.exists() or response.exists()}
bdl-8:fullUrl cannot be a version specific reference {fullUrl.contains('/_history/').not()}ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}"
"SDHRBatchBundle","Bundle.entry.id","Bundle.entry.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRBatchBundle","Bundle.entry.extension","Bundle.entry.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.modifierExtension","Bundle.entry.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.link","Bundle.entry.link","","","",0,*,"","","Y","null {[]} {[]}
","Links related to this entry","A series of links that provide context to this entry.","","","","","","","","","",,,,,"",,,,"Bundle.entry.link",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.fullUrl","Bundle.entry.fullUrl","","","",0,1,"","","Y","uri {[]} {[]}
","URI for resource (Absolute URL server address or URI for UUID/OID)","The Absolute URL for the resource.  The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: 
* fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
* Results from operations might involve resources that are not identified.","fullUrl might not be [unique in the context of a resource](http://hl7.org/fhir/R4/bundle.html#bundle-unique). Note that since [FHIR resources do not need to be served through the FHIR API](http://hl7.org/fhir/R4/references.html), the fullURL might be a URN or an absolute URL that does not end with the logical id of the resource (Resource.id). However, but if the fullUrl does look like a RESTful server URL (e.g. meets the [regex](http://hl7.org/fhir/R4/references.html#regex), then the 'id' portion of the fullUrl SHALL end with the Resource.id.

Note that the fullUrl is not the same as the canonical URL - it's an absolute url for an endpoint serving the resource (these will happen to have the same value on the canonical server for the resource with the canonical URL).","","","","","","","","",,,,,"",,,,"Bundle.entry.fullUrl",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.resource","Bundle.entry.resource","","","",0,1,"","","Y","Resource {[]} {[]}
","A resource in the bundle","The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.","","","","","","","","","",,,,,"",,,,"Bundle.entry.resource",0,1,"",""
"SDHRBatchBundle","Bundle.entry.search","Bundle.entry.search","","","",0,1,"","","Y","BackboneElement {[]} {[]}
","Search related information","Information about the search process that lead to the creation of this entry.","","","","","","","","","",,,,,"",,,,"Bundle.entry.search",0,1,"bdl-2
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.search.id","Bundle.entry.search.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRBatchBundle","Bundle.entry.search.extension","Bundle.entry.search.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.search.modifierExtension","Bundle.entry.search.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.search.mode","Bundle.entry.search.mode","","","",0,1,"","","Y","code {[]} {[]}
","match | include | outcome - why this is in the result set","Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.","There is only one mode. In some corner cases, a resource may be included because it is both a match and an include. In these circumstances, 'match' takes precedence.","","","","","","","","",,"required","Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.","http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1","",,,,"Bundle.entry.search.mode",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.search.score","Bundle.entry.search.score","","","",0,1,"","","Y","decimal {[]} {[]}
","Search ranking (between 0 and 1)","When searching, the server's search ranking score for the entry.","Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order.

See [Patient Match](http://hl7.org/fhir/R4/patient-operation-match.html) for the EMPI search which relates to this element.","","","","","","","","",,,,,"",,,,"Bundle.entry.search.score",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request","Bundle.entry.request","","","",0,1,"","","Y","BackboneElement {[]} {[]}
","Additional execution information (transaction/batch/history)","Additional information about how this entry should be processed as part of a transaction or batch.  For history, it shows how the entry was processed to create the version contained in the entry.","","","","","","","","","",,,,,"",,,,"Bundle.entry.request",0,1,"bdl-3
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.id","Bundle.entry.request.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRBatchBundle","Bundle.entry.request.extension","Bundle.entry.request.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.request.modifierExtension","Bundle.entry.request.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.request.method","Bundle.entry.request.method","","","",1,1,"","","Y","code {[]} {[]}
","GET | HEAD | POST | PUT | DELETE | PATCH","In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.","","","","","","","","","",,"required","HTTP verbs (in the HTTP command line). See [HTTP rfc](https://tools.ietf.org/html/rfc7231) for details.","http://hl7.org/fhir/ValueSet/http-verb|4.0.1","",,,,"Bundle.entry.request.method",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.url","Bundle.entry.request.url","","","",1,1,"","","Y","uri {[]} {[]}
","URL for HTTP equivalent of this entry","The URL for this entry, relative to the root (the address to which the request is posted).","E.g. for a Patient Create, the method would be ""POST"" and the URL would be ""Patient"". For a Patient Update, the method would be PUT and the URL would be ""Patient/[id]"".","","","","","","","","",,,,,"",,,,"Bundle.entry.request.url",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.ifNoneMatch","Bundle.entry.request.ifNoneMatch","","","",0,1,"","","Y","string {[]} {[]}
","For managing cache currency","If the ETag values match, return a 304 Not Modified status. See the API documentation for [""Conditional Read""](http://hl7.org/fhir/R4/http.html#cread).","","","","","","","","","",,,,,"",,,,"Bundle.entry.request.ifNoneMatch",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.ifModifiedSince","Bundle.entry.request.ifModifiedSince","","","",0,1,"","","Y","instant {[]} {[]}
","For managing cache currency","Only perform the operation if the last updated date matches. See the API documentation for [""Conditional Read""](http://hl7.org/fhir/R4/http.html#cread).","","","","","","","","","",,,,,"",,,,"Bundle.entry.request.ifModifiedSince",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.ifMatch","Bundle.entry.request.ifMatch","","","",0,1,"","","Y","string {[]} {[]}
","For managing update contention","Only perform the operation if the Etag value matches. For more information, see the API section [""Managing Resource Contention""](http://hl7.org/fhir/R4/http.html#concurrency).","","","","","","","","","",,,,,"",,,,"Bundle.entry.request.ifMatch",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.request.ifNoneExist","Bundle.entry.request.ifNoneExist","","","",0,1,"","","Y","string {[]} {[]}
","For conditional creates","Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [""Conditional Create""](http://hl7.org/fhir/R4/http.html#ccreate). This is just the query portion of the URL - what follows the ""?"" (not including the ""?"").","","","","","","","","","",,,,,"",,,,"Bundle.entry.request.ifNoneExist",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response","Bundle.entry.response","","","",0,1,"","","Y","BackboneElement {[]} {[]}
","Results of execution (transaction/batch/history)","Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.","","","","","","","","","",,,,,"",,,,"Bundle.entry.response",0,1,"bdl-4
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response.id","Bundle.entry.response.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRBatchBundle","Bundle.entry.response.extension","Bundle.entry.response.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.response.modifierExtension","Bundle.entry.response.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRBatchBundle","Bundle.entry.response.status","Bundle.entry.response.status","","","",1,1,"","","Y","string {[]} {[]}
","Status response code (text optional)","The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.","","","","","","","","","",,,,,"",,,,"Bundle.entry.response.status",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response.location","Bundle.entry.response.location","","","",0,1,"","","Y","uri {[]} {[]}
","The location (if the operation returns a location)","The location header created by processing this operation, populated if the operation returns a location.","","","","","","","","","",,,,,"",,,,"Bundle.entry.response.location",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response.etag","Bundle.entry.response.etag","","","",0,1,"","","Y","string {[]} {[]}
","The Etag for the resource (if relevant)","The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http://hl7.org/fhir/R4/http.html#versioning) and [Managing Resource Contention](http://hl7.org/fhir/R4/http.html#concurrency)).","Etags match the Resource.meta.versionId. The ETag has to match the version id in the header if a resource is included.","","","","","","","","",,,,,"",,,,"Bundle.entry.response.etag",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response.lastModified","Bundle.entry.response.lastModified","","","",0,1,"","","Y","instant {[]} {[]}
","Server's date time modified","The date/time that the resource was modified on the server.","This has to match the same time in the meta header (meta.lastUpdated) if a resource is included.","","","","","","","","",,,,,"",,,,"Bundle.entry.response.lastModified",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRBatchBundle","Bundle.entry.response.outcome","Bundle.entry.response.outcome","","","",0,1,"","","Y","Resource {[]} {[]}
","OperationOutcome with hints and warnings (for batch/transaction)","An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.","For a POST/PUT operation, this is the equivalent outcome that would be returned for prefer = operationoutcome - except that the resource is always returned whether or not the outcome is returned.

This outcome is not used for error responses in batch/transaction, only for hints and warnings. In a batch operation, the error will be in Bundle.entry.response, and for transaction, there will be a single OperationOutcome instead of a bundle in the case of an error.","","","","","","","","",,,,,"",,,,"Bundle.entry.response.outcome",0,1,"",""
"SDHRBatchBundle","Bundle.signature","Bundle.signature","","","",0,1,"","","Y","Signature {[]} {[]}
","Digital Signature","Digital Signature - base64 encoded. XML-DSig or a JWT.","The signature could be created by the ""author"" of the bundle or by the originating device.   Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.","A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.","","","","","","","",,,,,"",,,,"Bundle.signature",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition","Condition","","","",0,*,"","","","null {[]} {[]}
","Detailed information about conditions, problems or diagnoses","A clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.","","","","","","","","","",,,,,"",,,,"Condition",0,*,"","con-3:Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item {clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()}
con-4:If condition is abated, then clinicalStatus must be either inactive, resolved, or remission {abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()}con-5:Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error {verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()}dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}dom-3: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 {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()}dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated {contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()}dom-5:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}"
"SDHRCondition","Condition.id","Condition.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRCondition","Condition.meta","Condition.meta","","","",1,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.meta.id","Condition.meta.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.meta.extension","Condition.meta.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.meta.versionId","Condition.meta.versionId","","","",0,1,"","","Y","id {[]} {[]}
","Version specific identifier","The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.","The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.","","","","","","","","",,,,,"",,,,"Meta.versionId",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.meta.lastUpdated","Condition.meta.lastUpdated","","","",0,1,"","","Y","instant {[]} {[]}
","When the resource version last changed","When the resource last changed - e.g. when the version changed.","This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.","","","","","","","","",,,,,"",,,,"Meta.lastUpdated",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.meta.source","Condition.meta.source","","","",1,1,"","","Y","uri {[]} {[]}
","Captures the source of the record - please see description for details","Captures the source of the record. This must contain the HPIFacilityID
                            e.g. https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A","In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. 

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.","","","","","","","","",,,,,"",,,,"Meta.source",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
hpi-location-url-format:Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A {matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')}"
"SDHRCondition","Condition.meta.profile","Condition.meta.profile","","","",1,1,"","","Y","canonical {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1]]}
","Profiles this resource claims to conform to","A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).","It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.","","","","","","","","",,,,,"",,,,"Meta.profile",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.meta.security","Condition.meta.security","","","",0,*,"","","Y","Coding {[]} {[]}
","Security Labels applied to this resource","Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.","The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"extensible","Security Labels from the Healthcare Privacy and Security Classification System.","http://hl7.org/fhir/ValueSet/security-labels|4.0.1","",,,,"Meta.security",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.meta.tag","Condition.meta.tag","","","",0,*,"","","Y","Coding {[]} {[]}
","Tag the resource with a code to indicate usability components of the resource","Tag the resource with a code to indicate usability components of the resource. This is used to indicate that the resource is important and, for example, should be highlighted in a user interface.","The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"preferred","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-resource-tags-valueset","",,,,"Meta.tag",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.implicitRules","Condition.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.language","Condition.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.text","Condition.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.contained","Condition.contained","","inline resources
anonymous resourcescontained resources","",0,0,"","","","Resource {[]} {[]}
","Contained, inline Resources","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"",""
"SDHRCondition","Condition.extension","Condition.extension","","","",1,*,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","",,"open","DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.extension:long-term-condition","Condition.extension","long-term-condition","","",0,1,"","","","Extension {[CanonicalType[http://hl7.org.nz/fhir/StructureDefinition/long-term-condition]]} {[]}
","Long Term Condition Indicator","Long Term Condition Indicator. A long term condition can be  defined as any ongoing, long term or recurring conditions that can have a significant impact on people’s lives.","","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.extension:ClientLastUpdated","Condition.extension","ClientLastUpdated","","",1,1,"","","","Extension {[CanonicalType[https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension]]} {[]}
","Client Last Updated","Extension to record the last time a resource was updated by the source system. When consuming applications are writing data to the SDHR API they can use this extension to record the `LastUpdated` timestamp in their system","","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.extension:Highlighted","Condition.extension","Highlighted","","",0,1,"","","","Extension {[CanonicalType[https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension]]} {[]}
","HNZ SDHR Highlighted","Extension to indicate that a resource should be highlighted in the user interface. This is used to indicate that the resource is important and should be highlighted in a user interface.","","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.modifierExtension","Condition.modifierExtension","","","",0,0,"","Y","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.identifier","Condition.identifier","","","",1,*,"","","Y","Identifier {[]} {[]}
","A local identifier MUST be added to this section. If used, system MUST be specified.","A local identifier MUST be added to this section. This can be used to correlate the SDHR resource with a local system identifier to perform updates.","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 a Person resource instance might share the same social insurance number.","Allows identification of the condition as it is known by various participating systems and in a way that remains consistent across servers.","","","","","","","",,,,,"",,,,"Condition.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.id","Condition.identifier.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.identifier.extension","Condition.identifier.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.identifier.use","Condition.identifier.use","","","",0,1,"","Y","Y","code {[]} {[]}
","The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.","The purpose of this identifier.","Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.","Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.","","","","","","","",,"required","Identifies the purpose for this identifier, if known .","http://hl7.org/fhir/ValueSet/identifier-use|4.0.1","",,,,"Identifier.use",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.type","Condition.identifier.type","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","Description of identifier","A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.","This element deals only with general categories of identifiers.  It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.   Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.","Allows users to make use of identifiers when the identifier system is not known.","","","","","","","",,"extensible","A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.","http://hl7.org/fhir/ValueSet/identifier-type|4.0.1","",,,,"Identifier.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.system","Condition.identifier.system","","","",1,1,"","","Y","uri {[]} {[]}
","System for the local identifier. This MUST be consistent per PMS/Health Application","Establishes the namespace for the value - that is, a URL that describes a set values that are unique.","Identifier.system is always case sensitive.","There are many sets  of identifiers.  To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""http://www.acme.com/identifiers/patient""/>","","",,,,,"",,,,"Identifier.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.value","Condition.identifier.value","","","",1,1,"","","Y","string {[]} {[]}
","The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710","The portion of the identifier typically relevant to the user and which is unique within the context of the system.","If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.  The value's primary purpose is computational mapping.  As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.)  A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.","","","","","","<valueString xmlns=""http://hl7.org/fhir"" value=""123456""/>","","",,,,,"",,,,"Identifier.value",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.period","Condition.identifier.period","","","",0,1,"","","Y","Period {[]} {[]}
","Time period when id is/was valid for use","Time period during which identifier is/was valid for use.","","","","","","","","","",,,,,"",,,,"Identifier.period",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.identifier.assigner","Condition.identifier.assigner","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Organization that issued id (may be just text)","Organization that issued/manages the identifier.","The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.","","","","","","","","",,,,,"",,,,"Identifier.assigner",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.clinicalStatus","Condition.clinicalStatus","","","",0,1,"","Y","Y","CodeableConcept {[]} {[]}
","active | recurrence | relapse | inactive | remission | resolved","The clinical status of the condition.","The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.","","","","","","","","",,"required","The clinical status of the condition or diagnosis.","http://hl7.org/fhir/ValueSet/condition-clinical|4.0.1","",,,,"Condition.clinicalStatus",0,1,"con-3
con-4con-5","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.verificationStatus","Condition.verificationStatus","","","",0,1,"","Y","Y","CodeableConcept {[]} {[]}
","unconfirmed | provisional | differential | confirmed | refuted | entered-in-error","The verification status to support the clinical status of the condition.","verificationStatus is not required.  For example, when a patient has abdominal pain in the ED, there is not likely going to be a verification status.
The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity.","","","","","","","","",,"required","The verification status to support or decline the clinical status of the condition or diagnosis.","http://hl7.org/fhir/ValueSet/condition-ver-status|4.0.1","",,,,"Condition.verificationStatus",0,1,"con-3
con-5","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.category","Condition.category","","","",0,*,"","","","CodeableConcept {[]} {[]}
","A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk","A means of categorising the different types of problem, to distinguish for example, a diagnosis, from a clinical risk","The categorization is often highly contextual and may appear poorly differentiated or not very useful in other contexts.","","","","","","","","",,"extensible","A category assigned to the condition.","http://hl7.org/fhir/ValueSet/condition-category","",,,,"Condition.category",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.severity","Condition.severity","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Subjective severity of condition","A subjective assessment of the severity of the condition as evaluated by the clinician.","Coding of the severity with a terminology is preferred, where possible.","","","","","","","","",,"preferred","A subjective assessment of the severity of the condition as evaluated by the clinician.","http://hl7.org/fhir/ValueSet/condition-severity","",,,,"Condition.severity",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code","Condition.code","","type
","",1,1,"","","Y","CodeableConcept {[]} {[]}
","Identification of the condition, problem or diagnosis","Identification of the condition, problem or diagnosis.","","0..1 to account for primarily narrative only resources.","","","","","","","",,"preferred","","http://hl7.org/fhir/ValueSet/condition-code","",,,,"Condition.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.id","Condition.code.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.code.extension","Condition.code.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.code.coding","Condition.code.coding","","","",0,*,"","","Y","Coding {[]} {[]}
","Code defined by a terminology system","A reference to a code defined by a terminology system.","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.","Allows for alternative encodings within a code system, and translations to other code systems.","","","","","","","",,,,,"",,,,"CodeableConcept.coding",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.coding.id","Condition.code.coding.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.code.coding.extension","Condition.code.coding.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.code.coding.system","Condition.code.coding.system","","","",0,1,"","","Y","uri {[]} {[]}
","Identity of the terminology system","The identification of the code system that defines the meaning of the symbol in the code.","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.","Need to be unambiguous about the source of the definition of the symbol.","","","","","","","",,,,,"",,,,"Coding.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.coding.version","Condition.code.coding.version","","","",0,1,"","","Y","string {[]} {[]}
","Version of the system - if relevant","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.","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.","","","","","","","","",,,,,"",,,,"Coding.version",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.coding.code","Condition.code.coding.code","","","",0,1,"","","Y","code {[]} {[]}
","Symbol in syntax defined by the system","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).","","Need to refer to a particular code in the system.","","","","","","","",,,,,"",,,,"Coding.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.coding.display","Condition.code.coding.display","","","",0,1,"","","Y","string {[]} {[]}
","Representation defined by the system","A representation of the meaning of the code in the system, following the rules of the system.","","Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.","","","","","","","",,,,,"",,,,"Coding.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.coding.userSelected","Condition.code.coding.userSelected","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates that the value has been selected by a system user","This field is used to maintain the code as selected by the source systems end user. For example, where a patient management system uses local codes or a non-common code set to record a substance or allergen this field indicates that the value is as selected by the system user. Some level of clinical interpretation may be required.","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.","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.","","","","","","","",,,,,"",,,,"Coding.userSelected",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.code.text","Condition.code.text","","","",0,1,"","","Y","string {[]} {[]}
","Plain text representation of the concept","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.","Very often the text is the same as a displayName of one of the codings.","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.","","","","","","","",,,,,"",,,,"CodeableConcept.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.bodySite","Condition.bodySite","","","",0,*,"","","Y","CodeableConcept {[]} {[]}
","Anatomical location, if relevant","The anatomical location where this condition manifests itself.","Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [bodySite](http://hl7.org/fhir/R4/extension-bodysite.html).  May be a summary code, or a reference to a very precise definition of the location, or both.","","","","","","","","",,"example","Codes describing anatomical locations. May include laterality.","http://hl7.org/fhir/ValueSet/body-site","",,,,"Condition.bodySite",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.subject","Condition.subject","","patient
","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient]]}
","National Health Identifier for the health consumer","National Health Identifier for the health consumer","","Group is typically used for veterinary or public health use cases.","","","","","","","",,,,,"",,,,"Condition.subject",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.subject.id","Condition.subject.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.subject.extension","Condition.subject.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.subject.reference","Condition.subject.reference","","","",1,1,"","","Y","string {[]} {[]}
","Must be an absolute URL reference to the patient on the NHI system. See constraints for details.","A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.","Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure ""/[type]/[id]"" then it should be assumed that the reference is to a FHIR RESTful server.","","","","","","","","",,,,,"",,,,"Reference.reference",0,1,"ref-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
nhi-url-format:Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA {matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')}"
"SDHRCondition","Condition.subject.type","Condition.subject.type","","","",1,1,"","","Y","uri {[]} {[]}
","Type the reference refers to (e.g. ""Patient"")","The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. ""Patient"" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).","This element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""Patient""/>","","","",,"extensible","Aa resource (or, for logical models, the URI of the logical model).","http://hl7.org/fhir/ValueSet/resource-types|4.0.1","",,,,"Reference.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.subject.identifier","Condition.subject.identifier","","","",0,1,"","","Y","Identifier {[]} {[]}
","Logical reference, when literal reference is not known","An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.","When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. 

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).","","","","","","","","",,,,,"",,,,"Reference.identifier",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.subject.display","Condition.subject.display","","","",0,1,"","","Y","string {[]} {[]}
","Text alternative for the resource","Plain text narrative that identifies the resource in addition to the resource reference.","This is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.","","","","","","","","",,,,,"",,,,"Reference.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.encounter","Condition.encounter","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Encounter]]}
","Encounter created as part of","The Encounter during which this Condition was created or to which the creation of this record is tightly associated.","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. This record indicates the encounter this particular record is associated with.  In the case of a ""new"" diagnosis reflecting ongoing/revised information about the condition, this might be distinct from the first encounter in which the underlying condition was first ""known"".","","","","","","","","",,,,,"",,,,"Condition.encounter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.onset[x]","Condition.onset[x]","","","",0,1,"","","Y","dateTime {[]} {[]}
","Estimated or actual date,  date-time, or age","Estimated or actual date or date-time  the condition began, in the opinion of the clinician.","Age is generally used when the patient reports an age at which the Condition began to occur.","","","","","","","","",,,,,"",,,,"Condition.onset[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.abatement[x]","Condition.abatement[x]","","","",0,1,"","","","dateTime {[]} {[]}
Age {[]} {[]}Period {[]} {[]}Range {[]} {[]}string {[]} {[]}","When in resolution/remission","The date or estimated date that the condition resolved or went into remission. This is called ""abatement"" because of the many overloaded connotations associated with ""remission"" or ""resolution"" - Conditions are never really resolved, but they can abate.","There is no explicit distinction between resolution and remission because in many cases the distinction is not clear. Age is generally used when the patient reports an age at which the Condition abated.  If there is no abatement element, it is unknown whether the condition has resolved or entered remission; applications and users should generally assume that the condition is still valid.  When abatementString exists, it implies the condition is abated.","","","","","","","","",,,,,"",,,,"Condition.abatement[x]",0,1,"con-4
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.recordedDate","Condition.recordedDate","","","",0,1,"","","Y","dateTime {[]} {[]}
","Date record was first recorded","The recordedDate represents when this particular Condition record was created in the system, which is often a system-generated date.","","","","","","","","","",,,,,"",,,,"Condition.recordedDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.recorder","Condition.recorder","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson]]}
","Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA","Individual who recorded the record and takes responsibility for its content.","","","","","","","","","",,,,,"",,,,"Condition.recorder",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.asserter","Condition.asserter","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson]]}
","Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA","Individual who is making the condition statement.","","","","","","","","","",,,,,"",,,,"Condition.asserter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.stage","Condition.stage","","","",0,*,"","","","BackboneElement {[]} {[]}
","Stage/grade, usually assessed formally","Clinical stage or grade of a condition. May include formal severity assessments.","","","","","","","","","",,,,,"",,,,"Condition.stage",0,*,"","con-1:Stage SHALL have summary or assessment {summary.exists() or assessment.exists()}
ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}"
"SDHRCondition","Condition.stage.id","Condition.stage.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.stage.extension","Condition.stage.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.stage.modifierExtension","Condition.stage.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.stage.summary","Condition.stage.summary","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Simple summary (disease specific)","A simple summary of the stage such as ""Stage 3"". The determination of the stage is disease-specific.","","","","","","","","","",,"example","Codes describing condition stages (e.g. Cancer stages).","http://hl7.org/fhir/ValueSet/condition-stage","",,,,"Condition.stage.summary",0,1,"con-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.stage.assessment","Condition.stage.assessment","","","",0,*,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/ClinicalImpression], CanonicalType[http://hl7.org/fhir/StructureDefinition/DiagnosticReport], CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation]]}
","Formal record of assessment","Reference to a formal record of the evidence on which the staging assessment is based.","","","","","","","","","",,,,,"",,,,"Condition.stage.assessment",0,*,"con-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.stage.type","Condition.stage.type","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Kind of staging","The kind of staging, such as pathological or clinical staging.","","","","","","","","","",,"example","Codes describing the kind of condition staging (e.g. clinical or pathological).","http://hl7.org/fhir/ValueSet/condition-stage-type","",,,,"Condition.stage.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.evidence","Condition.evidence","","","",0,*,"","","","BackboneElement {[]} {[]}
","Supporting evidence","Supporting evidence / manifestations that are the basis of the Condition's verification status, such as evidence that confirmed or refuted the condition.","The evidence may be a simple list of coded symptoms/manifestations, or references to observations or formal assessments, or both.","","","","","","","","",,,,,"",,,,"Condition.evidence",0,*,"","con-2:evidence SHALL have code or details {code.exists() or detail.exists()}
ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}"
"SDHRCondition","Condition.evidence.id","Condition.evidence.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRCondition","Condition.evidence.extension","Condition.evidence.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.evidence.modifierExtension","Condition.evidence.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRCondition","Condition.evidence.code","Condition.evidence.code","","","",0,*,"","","Y","CodeableConcept {[]} {[]}
","Manifestation/symptom","A manifestation or symptom that led to the recording of this condition.","","","","","","","","","",,"example","Codes that describe the manifestation or symptoms of a condition.","http://hl7.org/fhir/ValueSet/manifestation-or-symptom","",,,,"Condition.evidence.code",0,*,"con-2
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.evidence.detail","Condition.evidence.detail","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Resource]]}
","Supporting information found elsewhere","Links to other relevant information, including pathology reports.","","","","","","","","","",,,,,"",,,,"Condition.evidence.detail",0,*,"con-2
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRCondition","Condition.note","Condition.note","","","",0,*,"","","","Annotation {[]} {[]}
","Additional information about the Condition","Additional information about the Condition. This is a general notes/comments entry  for description of the Condition, its diagnosis and prognosis.","","","","","","","","","",,,,,"",,,,"Condition.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent","Consent","","","",0,*,"","","","null {[]} {[]}
","A healthcare consumer's  choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time","A record of a healthcare consumer’s  choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.","Broadly, there are 3 key areas of consent for patients: Consent around sharing information (aka Privacy Consent Directive - Authorization to Collect, Use, or Disclose information), consent for specific treatment, or kinds of treatment, and general advance care directives.","","","","","","","","",,,,,"",,,,"Consent",0,*,"","dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}
dom-3: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 {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()}dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated {contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()}dom-5:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}ppc-1:Either a Policy or PolicyRule {policy.exists() or policyRule.exists()}ppc-2:IF Scope=privacy, there must be a patient {patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()}ppc-3:IF Scope=research, there must be a patient {patient.exists() or scope.coding.where(system='something' and code='research').exists().not()}ppc-4:IF Scope=adr, there must be a patient {patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()}ppc-5:IF Scope=treatment, there must be a patient {patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()}"
"SDHRConsent","Consent.id","Consent.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRConsent","Consent.meta","Consent.meta","","","",0,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.implicitRules","Consent.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.language","Consent.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages|4.0.1","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.text","Consent.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.contained","Consent.contained","","inline resources
anonymous resourcescontained resources","",0,*,"","","","Resource {[]} {[]}
","Contained, inline Resources","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"",""
"SDHRConsent","Consent.extension","Consent.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.modifierExtension","Consent.modifierExtension","","extensions
user content","",0,*,"","Y","","Extension {[]} {[]}
","Extensions that cannot be ignored","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.identifier","Consent.identifier","","","",0,*,"","","Y","Identifier {[]} {[]}
","Identifier for this record (external references)","Unique identifier for this copy of the Consent Statement.","This identifier identifies this copy of the consent. Where this identifier is also used elsewhere as the identifier for a consent record (e.g. a CDA consent document) then the consent details are expected to be the same.","","","","","","<valueIdentifier xmlns=""http://hl7.org/fhir"">
  <system value=""http://acme.org/identifier/local/eCMS""/>
  <value value=""Local eCMS identifier""/>
</valueIdentifier>","","",,,,,"",,,,"Consent.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.status","Consent.status","","","",1,1,"","Y","Y","code {[]} {[]}
","The state of the Consent. This must be active to release data from the server","Indicates the current state of this consent.","This element is labeled as a modifier because the status contains the codes rejected and entered-in-error that mark the Consent as not currently valid.","The Consent Directive that is pointed to might be in various lifecycle states, e.g., a revoked Consent Directive.","","","","","","","",,"required","Indicates the state of the consent.","http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1","",,,,"Consent.status",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.scope","Consent.scope","","","",1,1,"","Y","Y","CodeableConcept {[]} {[]}
","Which of the four areas this resource covers (extensible)","A selector of the type of consent being presented: ADR, Privacy, Treatment, Research.  This list is now extensible.","","","","","","<valueCodeableConcept xmlns=""http://hl7.org/fhir"">
  <coding>
    <system value=""http://terminology.hl7.org/CodeSystem/consentscope""/>
    <code value=""patient-privacy""/>
  </coding>
</valueCodeableConcept>","","","",,"extensible","The four anticipated uses for the Consent Resource.","http://hl7.org/fhir/ValueSet/consent-scope|4.0.1","",,,,"Consent.scope",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.category","Consent.category","","","",1,1,"","","Y","CodeableConcept {[]} {[]}
","The category of the consent, which is a code that indicates the type of consent","The category of the consent, which is a code that indicates the type of consent","","","","","<valueCodeableConcept xmlns=""http://hl7.org/fhir"">
  <coding>
    <system value=""http://snomed.info/sct""/>
    <code value=""887031000000108""/>
  </coding>
</valueCodeableConcept>","","","","",,"extensible","A classification of the type of consents found in a consent statement.","http://hl7.org/fhir/ValueSet/consent-category|4.0.1","",,,,"Consent.category",1,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.patient","Consent.patient","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1]]}
","Who the consent applies to","The patient/healthcare consumer to whom this consent applies.","Commonly, the patient the consent pertains to is the author, but for young and old people, it may be some other person.","","","","","","","","",,,,,"",,,,"Consent.patient",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.patient.id","Consent.patient.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.patient.extension","Consent.patient.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.patient.reference","Consent.patient.reference","","","",1,1,"","","Y","string {[]} {[]}
","Must be an absolute URL reference to the patient on the NHI system. See constraints for details.","A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.","Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure ""/[type]/[id]"" then it should be assumed that the reference is to a FHIR RESTful server.","","","","","","","","",,,,,"",,,,"Reference.reference",0,1,"ref-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
nhi-url-format:Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA {matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')}"
"SDHRConsent","Consent.patient.type","Consent.patient.type","","","",1,1,"","","Y","uri {[]} {[]}
","Type the reference refers to (e.g. ""Patient"")","The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. ""Patient"" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).","This element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""Patient""/>","","","",,"extensible","Aa resource (or, for logical models, the URI of the logical model).","http://hl7.org/fhir/ValueSet/resource-types|4.0.1","",,,,"Reference.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.patient.identifier","Consent.patient.identifier","","","",0,1,"","","Y","Identifier {[]} {[]}
","Logical reference, when literal reference is not known","An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.","When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. 

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).","","","","","","","","",,,,,"",,,,"Reference.identifier",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.patient.display","Consent.patient.display","","","",0,1,"","","Y","string {[]} {[]}
","Text alternative for the resource","Plain text narrative that identifies the resource in addition to the resource reference.","This is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.","","","","","","","","",,,,,"",,,,"Reference.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.dateTime","Consent.dateTime","","","",0,1,"","","Y","dateTime {[]} {[]}
","When this Consent was created or indexed","When this  Consent was issued / created / indexed.","This is not the time of the original consent, but the time that this statement was made or derived.","","","","","","","","",,,,,"",,,,"Consent.dateTime",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.performer","Consent.performer","","consentor
","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1]]}
","Who is agreeing to the policy and rules","Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.","Commonly, the patient the consent pertains to is the consentor, but particularly for young and old people, it may be some other person - e.g. a legal guardian.","","","","","","","","",,,,,"",,,,"Consent.performer",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.organization","Consent.organization","","custodian
","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Custodian of the consent","The organization that manages the consent, and the framework within which it is executed.","","","","","","","","","",,,,,"",,,,"Consent.organization",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.source[x]","Consent.source[x]","","","",0,1,"","","Y","Attachment {[]} {[]}
Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Consent|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/DocumentReference|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Contract|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse|4.0.1]]}","Source from which this consent is taken","The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.","The source can be contained inline (Attachment), referenced directly (Consent), referenced in a consent repository (DocumentReference), or simply by an identifier (Identifier), e.g. a CDA document id.","","","","","","","","",,,,,"",,,,"Consent.source[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.policy","Consent.policy","","","",1,*,"","","","BackboneElement {[]} {[]}
","Policies covered by this consent","The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.","","","","","","","","","",,,,,"",,,,"Consent.policy",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.policy.id","Consent.policy.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.policy.extension","Consent.policy.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.policy.modifierExtension","Consent.policy.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.policy.authority","Consent.policy.authority","","","",0,1,"","","","uri {[]} {[]}
","Enforcement source for policy","Entity or Organization having regulatory jurisdiction or accountability for  enforcing policies pertaining to Consent Directives.","","","","","","","","","",,,,,"",,,,"Consent.policy.authority",0,1,"ppc-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.policy.uri","Consent.policy.uri","","","",0,1,"","","","uri {[]} {[]}
","Specific policy covered by this consent","The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.","This element is for discoverability / documentation and does not modify or qualify the policy rules.","","","","","","","","",,,,,"",,,,"Consent.policy.uri",0,1,"ppc-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.policyRule","Consent.policyRule","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","Regulation that this consents to","A reference to the specific base computable regulation or policy.","If the policyRule is absent, computable consent would need to be constructed from the elements of the Consent resource.","Might be a unique identifier of a policy set in XACML, or other rules engine.","","","","","","","",,"extensible","Regulatory policy examples.","http://hl7.org/fhir/ValueSet/consent-policy|4.0.1","",,,,"Consent.policyRule",0,1,"ppc-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.verification","Consent.verification","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Consent Verified by patient or family","Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.","","","","","","","","","",,,,,"",,,,"Consent.verification",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.verification.id","Consent.verification.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.verification.extension","Consent.verification.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.verification.modifierExtension","Consent.verification.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.verification.verified","Consent.verification.verified","","","",1,1,"","","Y","boolean {[]} {[]}
","Has been verified","Has the instruction been verified.","","","","","","","","","",,,,,"",,,,"Consent.verification.verified",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.verification.verifiedWith","Consent.verification.verifiedWith","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1]]}
","Person who verified","Who verified the instruction (Patient, Relative or other Authorized Person).","","","","","","","","","",,,,,"",,,,"Consent.verification.verifiedWith",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.verification.verificationDate","Consent.verification.verificationDate","","","",0,1,"","","","dateTime {[]} {[]}
","When consent verified","Date verification was collected.","","","","","","","","","",,,,,"",,,,"Consent.verification.verificationDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision","Consent.provision","","","",1,1,"","","Y","BackboneElement {[]} {[]}
","The provision of the consent, which may be a permit or deny","An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.","","","","","","","","","",,,,,"",,,,"Consent.provision",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.id","Consent.provision.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.extension","Consent.provision.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.modifierExtension","Consent.provision.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.type","Consent.provision.type","","","",1,1,"","","Y","code {[]} {[]}
","The type of consent, either permit or deny","Action  to take - permit or deny - when the rule conditions are met.  Not permitted in root rule, required in all nested rules.","","","","","","","","","",,"required","How a rule statement is applied, such as adding additional consent or removing consent.","http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1","",,,,"Consent.provision.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.period","Consent.provision.period","","","",0,1,"","","Y","Period {[]} {[]}
","Timeframe for this rule","The timeframe in this rule is valid.","","","","","","","","","",,,,,"",,,,"Consent.provision.period",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.period.id","Consent.provision.period.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.period.extension","Consent.provision.period.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.period.start","Consent.provision.period.start","","","",1,1,"","","Y","dateTime {[]} {[]}
","The date and time the Consent is considered to be in effect","The start of the period. The boundary is inclusive.","If the low element is missing, the meaning is that the low boundary is not known.","","","","","","","","",,,,,"",,,,"Period.start",0,1,"per-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.period.end","Consent.provision.period.end","","","",0,1,"","","Y","dateTime {[]} {[]}
","The date and time the Consent is considered to be expired","The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.","The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.","","","If the end of the period is missing, it means that the period is ongoing","","","","","",,,,,"",,,,"Period.end",0,1,"per-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.actor","Consent.provision.actor","","","",0,*,"","","","BackboneElement {[]} {[]}
","Who|what controlled by this rule (or group, by role)","Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').","","","","There is no specific actor associated with the exception","","","","","",,,,,"",,,,"Consent.provision.actor",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.actor.id","Consent.provision.actor.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.actor.extension","Consent.provision.actor.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.actor.modifierExtension","Consent.provision.actor.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.actor.role","Consent.provision.actor.role","","","",1,1,"","","","CodeableConcept {[]} {[]}
","How the actor is involved","How the individual is involved in the resources content that is described in the exception.","","","","","","","","","",,"extensible","How an actor is involved in the consent considerations.","http://hl7.org/fhir/ValueSet/security-role-type|4.0.1","",,,,"Consent.provision.actor.role",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.actor.reference","Consent.provision.actor.reference","","","",1,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Device|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Group|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/CareTeam|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1]]}
","Resource for the actor (or group, by role)","The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').","","","","","","","","","",,,,,"",,,,"Consent.provision.actor.reference",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.action","Consent.provision.action","","","",1,*,"","","Y","CodeableConcept {[]} {[]}
","The action that is being permitted or denied","Actions controlled by this Rule.","Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.","","","all actions","","","","","",,"example","Detailed codes for the consent action.","http://hl7.org/fhir/ValueSet/consent-action|4.0.1","",,,,"Consent.provision.action",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.securityLabel","Consent.provision.securityLabel","","","",0,*,"","","Y","Coding {[]} {[]}
","Security Labels that define affected resources","A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.","If the consent specifies a security label of ""R"" then it applies to all resources that are labeled ""R"" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.","","","","","","","","",,"extensible","Security Labels from the Healthcare Privacy and Security Classification System.","http://hl7.org/fhir/ValueSet/security-labels|4.0.1","",,,,"Consent.provision.securityLabel",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.purpose","Consent.provision.purpose","","","",0,*,"","","Y","Coding {[]} {[]}
","Context of activities covered by this rule","The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.","When the purpose of use tag is on the data, access request purpose of use shall not conflict.","","","","","","","","",,"extensible","What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.","http://terminology.hl7.org/ValueSet/v3-PurposeOfUse","",,,,"Consent.provision.purpose",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.class","Consent.provision.class","","","",0,*,"","","Y","Coding {[]} {[]}
","e.g. Resource Type, Profile, CDA, etc.","The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.","Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.","","","","","","","","",,"extensible","The class (type) of information a consent rule covers.","http://hl7.org/fhir/ValueSet/consent-content-class|4.0.1","",,,,"Consent.provision.class",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.code","Consent.provision.code","","","",0,*,"","","Y","CodeableConcept {[]} {[]}
","e.g. LOINC or SNOMED CT code, etc. in the content","If this code is found in an instance, then the rule applies.","Typical use of this is a Document code with class = CDA.","","","","","","","","",,"example","If this code is found in an instance, then the exception applies.","http://hl7.org/fhir/ValueSet/consent-content-code|4.0.1","",,,,"Consent.provision.code",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.dataPeriod","Consent.provision.dataPeriod","","","",0,1,"","","Y","Period {[]} {[]}
","Timeframe for data controlled by this rule","Clinical or Operational Relevant period of time that bounds the data controlled by this rule.","This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.","","","","","","","","",,,,,"",,,,"Consent.provision.dataPeriod",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.data","Consent.provision.data","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Data controlled by this rule","The resources controlled by this rule if specific resources are referenced.","","","","all data","","","","","",,,,,"",,,,"Consent.provision.data",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.data.id","Consent.provision.data.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.data.extension","Consent.provision.data.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.data.modifierExtension","Consent.provision.data.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.data.meaning","Consent.provision.data.meaning","","","",1,1,"","","Y","code {[]} {[]}
","instance | related | dependents | authoredby","How the resource reference is interpreted when testing consent restrictions.","","","","","","","","","",,"required","How a resource reference is interpreted when testing consent restrictions.","http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1","",,,,"Consent.provision.data.meaning",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.data.reference","Consent.provision.data.reference","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Resource|4.0.1]]}
","The actual data reference","A reference to a specific resource that defines which resources are covered by this consent.","","","","","","","","","",,,,,"",,,,"Consent.provision.data.reference",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision","Consent.provision.provision","","","",0,*,"","","","BackboneElement {[]} {[]}
","Nested Exception Rules","Rules which provide exceptions to the base rule or subrules.","","","","","","","","","",,,,,"",,,,"Consent.provision.provision",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.id","Consent.provision.provision.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.provision.extension","Consent.provision.provision.extension","","","",0,*,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.extension:FacilityParticipationExtension","Consent.provision.provision.extension","FacilityParticipationExtension","","",0,1,"","","","Extension {[CanonicalType[https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension]]} {[]}
","Indicates the patient has opted out of participation entirely at the facility","Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.","","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.modifierExtension","Consent.provision.provision.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.type","Consent.provision.provision.type","","","",0,1,"","","Y","code {[]} {[]}
","deny | permit","Action  to take - permit or deny - when the rule conditions are met.  Not permitted in root rule, required in all nested rules.","","","","","","","","","",,"required","How a rule statement is applied, such as adding additional consent or removing consent.","http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1","",,,,"Consent.provision.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.period","Consent.provision.provision.period","","","",0,1,"","","Y","Period {[]} {[]}
","Timeframe for this rule","The timeframe in this rule is valid.","","","","","","","","","",,,,,"",,,,"Consent.provision.period",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.actor","Consent.provision.provision.actor","","","",0,*,"","","","BackboneElement {[]} {[]}
","Who|what controlled by this rule (or group, by role)","Who or what is controlled by this rule. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').","","","","There is no specific actor associated with the exception","","","","","",,,,,"",,,,"Consent.provision.actor",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.actor.id","Consent.provision.provision.actor.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.provision.actor.extension","Consent.provision.provision.actor.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.actor.modifierExtension","Consent.provision.provision.actor.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.actor.role","Consent.provision.provision.actor.role","","","",1,1,"","","","CodeableConcept {[]} {[]}
","How the actor is involved","How the individual is involved in the resources content that is described in the exception.","","","","","","","","","",,"extensible","How an actor is involved in the consent considerations.","http://hl7.org/fhir/ValueSet/security-role-type|4.0.1","",,,,"Consent.provision.actor.role",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.actor.reference","Consent.provision.provision.actor.reference","","","",1,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Device|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Group|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/CareTeam|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1]]}
","Resource for the actor (or group, by role)","The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers').","","","","","","","","","",,,,,"",,,,"Consent.provision.actor.reference",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.action","Consent.provision.provision.action","","","",0,*,"","","Y","CodeableConcept {[]} {[]}
","Actions controlled by this rule","Actions controlled by this Rule.","Note that this is the direct action (not the grounds for the action covered in the purpose element). At present, the only action in the understood and tested scope of this resource is 'read'.","","","all actions","","","","","",,"example","Detailed codes for the consent action.","http://hl7.org/fhir/ValueSet/consent-action|4.0.1","",,,,"Consent.provision.action",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.securityLabel","Consent.provision.provision.securityLabel","","","",0,*,"","","Y","Coding {[]} {[]}
","Security Labels that define affected resources","A security label, comprised of 0..* security label fields (Privacy tags), which define which resources are controlled by this exception.","If the consent specifies a security label of ""R"" then it applies to all resources that are labeled ""R"" or lower. E.g. for Confidentiality, it's a high water mark. For other kinds of security labels, subsumption logic applies. When the purpose of use tag is on the data, access request purpose of use shall not conflict.","","","","","","","","",,"extensible","Security Labels from the Healthcare Privacy and Security Classification System.","http://hl7.org/fhir/ValueSet/security-labels|4.0.1","",,,,"Consent.provision.securityLabel",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.purpose","Consent.provision.provision.purpose","","","",0,*,"","","Y","Coding {[]} {[]}
","Context of activities covered by this rule","The context of the activities a user is taking - why the user is accessing the data - that are controlled by this rule.","When the purpose of use tag is on the data, access request purpose of use shall not conflict.","","","","","","","","",,"extensible","What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.","http://terminology.hl7.org/ValueSet/v3-PurposeOfUse","",,,,"Consent.provision.purpose",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.class","Consent.provision.provision.class","","","",0,*,"","","Y","Coding {[]} {[]}
","e.g. Resource Type, Profile, CDA, etc.","The class of information covered by this rule. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.","Multiple types are or'ed together. The intention of the contentType element is that the codes refer to profiles or document types defined in a standard or an implementation guide somewhere.","","","","","","","","",,"extensible","The class (type) of information a consent rule covers.","http://hl7.org/fhir/ValueSet/consent-content-class|4.0.1","",,,,"Consent.provision.class",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.code","Consent.provision.provision.code","","","",0,*,"","","Y","CodeableConcept {[]} {[]}
","e.g. LOINC or SNOMED CT code, etc. in the content","If this code is found in an instance, then the rule applies.","Typical use of this is a Document code with class = CDA.","","","","","","","","",,"example","If this code is found in an instance, then the exception applies.","http://hl7.org/fhir/ValueSet/consent-content-code|4.0.1","",,,,"Consent.provision.code",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.dataPeriod","Consent.provision.provision.dataPeriod","","","",0,1,"","","Y","Period {[]} {[]}
","Timeframe for data controlled by this rule","Clinical or Operational Relevant period of time that bounds the data controlled by this rule.","This has a different sense to the Consent.period - that is when the consent agreement holds. This is the time period of the data that is controlled by the agreement.","","","","","","","","",,,,,"",,,,"Consent.provision.dataPeriod",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.data","Consent.provision.provision.data","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Data controlled by this rule","The resources controlled by this rule if specific resources are referenced.","","","","all data","","","","","",,,,,"",,,,"Consent.provision.data",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.data.id","Consent.provision.provision.data.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRConsent","Consent.provision.provision.data.extension","Consent.provision.provision.data.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.data.modifierExtension","Consent.provision.provision.data.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRConsent","Consent.provision.provision.data.meaning","Consent.provision.provision.data.meaning","","","",1,1,"","","Y","code {[]} {[]}
","instance | related | dependents | authoredby","How the resource reference is interpreted when testing consent restrictions.","","","","","","","","","",,"required","How a resource reference is interpreted when testing consent restrictions.","http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1","",,,,"Consent.provision.data.meaning",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.data.reference","Consent.provision.provision.data.reference","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Resource|4.0.1]]}
","The actual data reference","A reference to a specific resource that defines which resources are covered by this consent.","","","","","","","","","",,,,,"",,,,"Consent.provision.data.reference",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRConsent","Consent.provision.provision.provision","Consent.provision.provision.provision","","","",0,*,"","","","null {[]} {[]}
","Nested Exception Rules","Rules which provide exceptions to the base rule or subrules.","","","","","","","","","",,,,,"",,,,"Consent.provision.provision",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization","Immunization","","","",0,*,"","","","null {[]} {[]}
","Immunization event information","Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.","","","","","","","","","",,,,,"",,,,"Immunization",0,*,"","dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}
dom-3: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 {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()}dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated {contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()}dom-5:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}"
"SDHRImmunization","Immunization.id","Immunization.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRImmunization","Immunization.meta","Immunization.meta","","","",0,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.implicitRules","Immunization.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.language","Immunization.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages|4.0.1","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.text","Immunization.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.contained","Immunization.contained","","inline resources
anonymous resourcescontained resources","",0,*,"","","","Resource {[]} {[]}
","Contained, inline Resources","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"",""
"SDHRImmunization","Immunization.extension","Immunization.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.modifierExtension","Immunization.modifierExtension","","extensions
user content","",0,*,"","Y","","Extension {[]} {[]}
","Extensions that cannot be ignored","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.identifier","Immunization.identifier","","","",0,*,"","","","Identifier {[]} {[]}
","Business identifier","A unique identifier assigned to this immunization record.","","","","","","","","","",,,,,"",,,,"Immunization.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.status","Immunization.status","","","",1,1,"","Y","Y","code {[]} {[]}
","completed | entered-in-error | not-done","Indicates the current status of the immunization event.","Will generally be set to show that the immunization has been completed or not done.  This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","","","","","","","","",,"required","A set of codes indicating the current status of an Immunization.","http://hl7.org/fhir/ValueSet/immunization-status|4.0.1","",,,,"Immunization.status",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.statusReason","Immunization.statusReason","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Reason not done","Indicates the reason the immunization event was not performed.","This is generally only used for the status of ""not-done"". The reason for performing the immunization event is captured in reasonCode, not here.","","","","","","","","",,"example","The reason why a vaccine was not administered.","http://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1","",,,,"Immunization.statusReason",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.vaccineCode","Immunization.vaccineCode","","","",1,1,"","","Y","CodeableConcept {[]} {[]}
","Vaccine product administered","Vaccine that was administered or was to be administered.","","","","","","","","","",,"example","The code for vaccine product administered.","http://hl7.org/fhir/ValueSet/vaccine-code|4.0.1","",,,,"Immunization.vaccineCode",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.patient","Immunization.patient","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1]]}
","Who was immunized","The patient who either received or did not receive the immunization.","","","","","","","","","",,,,,"",,,,"Immunization.patient",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.encounter","Immunization.encounter","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1]]}
","Encounter immunization was part of","The visit or admission or other contact between patient and health care provider the immunization was performed as part of.","","","","","","","","","",,,,,"",,,,"Immunization.encounter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.occurrence[x]","Immunization.occurrence[x]","","","",1,1,"","","Y","dateTime {[]} {[]}
string {[]} {[]}","Vaccine administration date","Date vaccine administered or was to be administered.","When immunizations are given a specific date and time should always be known.   When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.","","","","","","","","",,,,,"",,,,"Immunization.occurrence[x]",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.recorded","Immunization.recorded","","","",0,1,"","","","dateTime {[]} {[]}
","When the immunization was first captured in the subject's record","The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.","","","","","","","","","",,,,,"",,,,"Immunization.recorded",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.primarySource","Immunization.primarySource","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates context the data was recorded in","An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.","Reflects the “reliability” of the content.","","","","","","","","",,,,,"",,,,"Immunization.primarySource",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reportOrigin","Immunization.reportOrigin","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Indicates the source of a secondarily reported record","The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.","Should not be populated if primarySource = True, not required even if primarySource = False.","","","","","","","","",,"example","The source of the data for a record which is not from a primary source.","http://hl7.org/fhir/ValueSet/immunization-origin|4.0.1","",,,,"Immunization.reportOrigin",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.location","Immunization.location","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Location|4.0.1]]}
","Where immunization occurred","The service delivery location where the vaccine administration occurred.","","","","","","","","","",,,,,"",,,,"Immunization.location",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.manufacturer","Immunization.manufacturer","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Vaccine manufacturer","Name of vaccine manufacturer.","","","","","","","","","",,,,,"",,,,"Immunization.manufacturer",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.lotNumber","Immunization.lotNumber","","","",0,1,"","","","string {[]} {[]}
","Vaccine lot number","Lot number of the  vaccine product.","","","","","","","","","",,,,,"",,,,"Immunization.lotNumber",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.expirationDate","Immunization.expirationDate","","","",0,1,"","","","date {[]} {[]}
","Vaccine expiration date","Date vaccine batch expires.","","","","","","","","","",,,,,"",,,,"Immunization.expirationDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.site","Immunization.site","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Body site vaccine  was administered","Body site where vaccine was administered.","","","","","","","","","",,"example","The site at which the vaccine was administered.","http://hl7.org/fhir/ValueSet/immunization-site|4.0.1","",,,,"Immunization.site",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.route","Immunization.route","","","",0,1,"","","","CodeableConcept {[]} {[]}
","How vaccine entered body","The path by which the vaccine product is taken into the body.","","","","","","","","","",,"example","The route by which the vaccine was administered.","http://hl7.org/fhir/ValueSet/immunization-route|4.0.1","",,,,"Immunization.route",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.doseQuantity","Immunization.doseQuantity","","","",0,1,"","","","Quantity {[CanonicalType[http://hl7.org/fhir/StructureDefinition/SimpleQuantity|4.0.1]]} {[]}
","Amount of vaccine administered","The quantity of vaccine product that was administered.","","","","","","","","","",,,,,"",,,,"Immunization.doseQuantity",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.performer","Immunization.performer","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Who performed event","Indicates who performed the immunization event.","","","","","","","","","",,,,,"",,,,"Immunization.performer",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.performer.id","Immunization.performer.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRImmunization","Immunization.performer.extension","Immunization.performer.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.performer.modifierExtension","Immunization.performer.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.performer.function","Immunization.performer.function","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","What type of performance was done","Describes the type of performance (e.g. ordering provider, administering provider, etc.).","","","","","","","","","",,"extensible","The role a practitioner or organization plays in the immunization event.","http://hl7.org/fhir/ValueSet/immunization-function|4.0.1","",,,,"Immunization.performer.function",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.performer.actor","Immunization.performer.actor","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Individual or organization who was performing","The practitioner or organization who performed the action.","When the individual practitioner who performed the action is known, it is best to send.","","","","","","","","",,,,,"",,,,"Immunization.performer.actor",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.note","Immunization.note","","","",0,*,"","","Y","Annotation {[]} {[]}
","Additional immunization notes","Extra information about the immunization that is not conveyed by the other attributes.","","","","","","","","","",,,,,"",,,,"Immunization.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reasonCode","Immunization.reasonCode","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Why immunization occurred","Reasons why the vaccine was administered.","","","","","","","","","",,"example","The reason why a vaccine was administered.","http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1","",,,,"Immunization.reasonCode",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reasonReference","Immunization.reasonReference","","","",0,*,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Condition|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/DiagnosticReport|4.0.1]]}
","Why immunization occurred","Condition, Observation or DiagnosticReport that supports why the immunization was administered.","","","","","","","","","",,,,,"",,,,"Immunization.reasonReference",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.isSubpotent","Immunization.isSubpotent","","","",0,1,"","Y","Y","boolean {[]} {[]}
","Dose potency","Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.","Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.","","","By default, a dose should be considered to be potent.","","","","","",,,,,"",,,,"Immunization.isSubpotent",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.subpotentReason","Immunization.subpotentReason","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Reason for being subpotent","Reason why a dose is considered to be subpotent.","","","","","","","","","",,"example","The reason why a dose is considered to be subpotent.","http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|4.0.1","",,,,"Immunization.subpotentReason",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.education","Immunization.education","","","",0,*,"","","","BackboneElement {[]} {[]}
","Educational material presented to patient","Educational material presented to the patient (or guardian) at the time of vaccine administration.","","","","","","","","","",,,,,"",,,,"Immunization.education",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
imm-1:One of documentType or reference SHALL be present {documentType.exists() or reference.exists()}"
"SDHRImmunization","Immunization.education.id","Immunization.education.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRImmunization","Immunization.education.extension","Immunization.education.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.education.modifierExtension","Immunization.education.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.education.documentType","Immunization.education.documentType","","","",0,1,"","","","string {[]} {[]}
","Educational material document identifier","Identifier of the material presented to the patient.","","","","","","","","","",,,,,"",,,,"Immunization.education.documentType",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.education.reference","Immunization.education.reference","","","",0,1,"","","","uri {[]} {[]}
","Educational material reference pointer","Reference pointer to the educational material given to the patient if the information was on line.","","","","","","","","","",,,,,"",,,,"Immunization.education.reference",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.education.publicationDate","Immunization.education.publicationDate","","","",0,1,"","","","dateTime {[]} {[]}
","Educational material publication date","Date the educational material was published.","","","","","","","","","",,,,,"",,,,"Immunization.education.publicationDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.education.presentationDate","Immunization.education.presentationDate","","","",0,1,"","","","dateTime {[]} {[]}
","Educational material presentation date","Date the educational material was given to the patient.","","","","","","","","","",,,,,"",,,,"Immunization.education.presentationDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.programEligibility","Immunization.programEligibility","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Patient eligibility for a vaccination program","Indicates a patient's eligibility for a funding program.","","","","","","","","","",,"example","The patient's eligibility for a vaccation program.","http://hl7.org/fhir/ValueSet/immunization-program-eligibility|4.0.1","",,,,"Immunization.programEligibility",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.fundingSource","Immunization.fundingSource","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Funding source for the vaccine","Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).","","","","","","","","","",,"example","The source of funding used to purchase the vaccine administered.","http://hl7.org/fhir/ValueSet/immunization-funding-source|4.0.1","",,,,"Immunization.fundingSource",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reaction","Immunization.reaction","","","",0,*,"","","","BackboneElement {[]} {[]}
","Details of a reaction that follows immunization","Categorical data indicating that an adverse event is associated in time to an immunization.","A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.","","","","","","","","",,,,,"",,,,"Immunization.reaction",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reaction.id","Immunization.reaction.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRImmunization","Immunization.reaction.extension","Immunization.reaction.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.reaction.modifierExtension","Immunization.reaction.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.reaction.date","Immunization.reaction.date","","","",0,1,"","","","dateTime {[]} {[]}
","When reaction started","Date of reaction to the immunization.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.date",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reaction.detail","Immunization.reaction.detail","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|4.0.1]]}
","Additional information on reaction","Details of the reaction.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.detail",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.reaction.reported","Immunization.reaction.reported","","","",0,1,"","","","boolean {[]} {[]}
","Indicates self-reported reaction","Self-reported indicator.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.reported",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied","Immunization.protocolApplied","","","",0,*,"","","","BackboneElement {[]} {[]}
","Protocol followed by the provider","The protocol (set of recommendations) being followed by the provider who administered the dose.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied.id","Immunization.protocolApplied.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRImmunization","Immunization.protocolApplied.extension","Immunization.protocolApplied.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.protocolApplied.modifierExtension","Immunization.protocolApplied.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRImmunization","Immunization.protocolApplied.series","Immunization.protocolApplied.series","","","",0,1,"","","","string {[]} {[]}
","Name of vaccine series","One possible path to achieve presumed immunity against a disease - within the context of an authority.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.series",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied.authority","Immunization.protocolApplied.authority","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Who is responsible for publishing the recommendations","Indicates the authority who published the protocol (e.g. ACIP) that is being followed.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.authority",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied.targetDisease","Immunization.protocolApplied.targetDisease","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Vaccine preventatable disease being targetted","The vaccine preventable disease the dose is being administered against.","","","","","","","","","",,"example","The vaccine preventable disease the dose is being administered for.","http://hl7.org/fhir/ValueSet/immunization-target-disease|4.0.1","",,,,"Immunization.protocolApplied.targetDisease",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied.doseNumber[x]","Immunization.protocolApplied.doseNumber[x]","","","",1,1,"","","","positiveInt {[]} {[]}
string {[]} {[]}","Dose number within series","Nominal position in a series.","The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.doseNumber[x]",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRImmunization","Immunization.protocolApplied.seriesDoses[x]","Immunization.protocolApplied.seriesDoses[x]","","","",0,1,"","","","positiveInt {[]} {[]}
string {[]} {[]}","Recommended number of doses for immunity","The recommended number of doses to achieve immunity.","The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.seriesDoses[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation","Observation","","Vital Signs
MeasurementResultsTests","",0,*,"","","","null {[]} {[]}
","Measurements and simple assertions","Measurements and simple assertions made about a patient, device or other subject.","Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc.  Other resources are used to provide context for observations such as laboratory reports, etc.","","","","","","","","",,,,,"",,,,"Observation",0,*,"","dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}
dom-3: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 {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()}dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated {contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()}dom-5:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}obs-6:dataAbsentReason SHALL only be present if Observation.value[x] is not present {dataAbsentReason.empty() or value.empty()}obs-7:If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present {value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()}value-or-dataabsentreason-required:Observations must have a root or component value[x], or a root or component dataAbsentReason. {value.exists() or component.value.exists() or dataAbsentReason.exists() or component.dataAbsentReason.exists()}"
"SDHRObservation","Observation.id","Observation.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","The only time that a resource does not have an id is when it is being submitted to the server using a create operation.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"SDHRObservation","Observation.meta","Observation.meta","","","",1,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","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.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.meta.id","Observation.meta.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.meta.extension","Observation.meta.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.meta.versionId","Observation.meta.versionId","","","",0,1,"","","Y","id {[]} {[]}
","Version specific identifier","The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.","The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.","","","","","","","","",,,,,"",,,,"Meta.versionId",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.meta.lastUpdated","Observation.meta.lastUpdated","","","",0,1,"","","Y","instant {[]} {[]}
","When the resource version last changed","When the resource last changed - e.g. when the version changed.","This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.","","","","","","","","",,,,,"",,,,"Meta.lastUpdated",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.meta.source","Observation.meta.source","","","",1,1,"","","Y","uri {[]} {[]}
","Captures the source of the record - please see description for details","Captures the source of the record. This must contain the HPIFacilityID
                            e.g. https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A","In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. 

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.","","","","","","","","",,,,,"",,,,"Meta.source",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
hpi-location-url-format:Reference must be an HPI Location URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Location/FZZ111-A {matches('^https://api.hip.digital.health.nz/fhir/hpi/v1/Location/F[A-Za-z0-9]{2}[0-9]{3}-[A-Za-z0-9]$')}"
"SDHRObservation","Observation.meta.profile","Observation.meta.profile","","","",1,1,"","","Y","canonical {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1]]}
","Profiles this resource claims to conform to","A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).","It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.  The list of profile URLs is a set.","","","","","","","","",,,,,"",,,,"Meta.profile",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.meta.security","Observation.meta.security","","","",0,*,"","","Y","Coding {[]} {[]}
","Security Labels applied to this resource","Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.","The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"extensible","Security Labels from the Healthcare Privacy and Security Classification System.","http://hl7.org/fhir/ValueSet/security-labels|4.0.1","",,,,"Meta.security",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.meta.tag","Observation.meta.tag","","","",0,*,"","","Y","Coding {[]} {[]}
","Tag the resource with a code to indicate usability components of the resource","Tag the resource with a code to indicate usability components of the resource. This is used to indicate that the resource is important and, for example, should be highlighted in a user interface.","The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.","","","","","","","","",,"preferred","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-resource-tags-valueset","",,,,"Meta.tag",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.implicitRules","Observation.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","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.","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.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.language","Observation.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","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).","","","","","","","","",,"preferred","A human language.","http://hl7.org/fhir/ValueSet/languages|4.0.1","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.text","Observation.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.contained","Observation.contained","","inline resources
anonymous resourcescontained resources","",0,0,"","","","Resource {[]} {[]}
","Contained, inline Resources","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.","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.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"",""
"SDHRObservation","Observation.extension","Observation.extension","","","",1,*,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","",,"open","DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.extension:ClientLastUpdated","Observation.extension","ClientLastUpdated","","",1,1,"","","","Extension {[CanonicalType[https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension]]} {[]}
","Client Last Updated","Extension to record the last time a resource was updated by the source system. When consuming applications are writing data to the SDHR API they can use this extension to record the `LastUpdated` timestamp in their system","","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.modifierExtension","Observation.modifierExtension","","","",0,0,"","Y","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.identifier","Observation.identifier","","","",1,*,"","","Y","Identifier {[]} {[]}
","A local identifier MUST be added to this section. If used, system MUST be specified.","A local identifier MUST be added to this section. This can be used to correlate the SDHR resource with a local system identifier to perform updates.","","Allows observations to be distinguished and referenced.","","","","","","","",,,,,"",,,,"Observation.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.id","Observation.identifier.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.identifier.extension","Observation.identifier.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.identifier.use","Observation.identifier.use","","","",0,1,"","Y","Y","code {[]} {[]}
","The local identifier use SHOULD be set to secondary, where the SDHR resource id is considered the primary identifier.","The purpose of this identifier.","Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.","Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.","","","","","","","",,"required","Identifies the purpose for this identifier, if known .","http://hl7.org/fhir/ValueSet/identifier-use|4.0.1","",,,,"Identifier.use",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.type","Observation.identifier.type","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","Description of identifier","A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.","This element deals only with general categories of identifiers.  It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.   Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.","Allows users to make use of identifiers when the identifier system is not known.","","","","","","","",,"extensible","A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.","http://hl7.org/fhir/ValueSet/identifier-type|4.0.1","",,,,"Identifier.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.system","Observation.identifier.system","","","",1,1,"","","Y","uri {[]} {[]}
","System for the local identifier. This MUST be consistent per PMS/Health Application","Establishes the namespace for the value - that is, a URL that describes a set values that are unique.","Identifier.system is always case sensitive.","There are many sets  of identifiers.  To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""http://www.acme.com/identifiers/patient""/>","","",,,,,"",,,,"Identifier.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.value","Observation.identifier.value","","","",1,1,"","","Y","string {[]} {[]}
","The actual local identifier value, e.g. ec2d6cad-1e19-46ee-accf-dc460a680710","The portion of the identifier typically relevant to the user and which is unique within the context of the system.","If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.  The value's primary purpose is computational mapping.  As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.)  A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.","","","","","","<valueString xmlns=""http://hl7.org/fhir"" value=""123456""/>","","",,,,,"",,,,"Identifier.value",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.period","Observation.identifier.period","","","",0,1,"","","Y","Period {[]} {[]}
","Time period when id is/was valid for use","Time period during which identifier is/was valid for use.","","","","","","","","","",,,,,"",,,,"Identifier.period",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.identifier.assigner","Observation.identifier.assigner","","","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1]]}
","Organization that issued id (may be just text)","Organization that issued/manages the identifier.","The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.","","","","","","","","",,,,,"",,,,"Identifier.assigner",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.basedOn","Observation.basedOn","","Fulfills
","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/CarePlan|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/DeviceRequest|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/MedicationRequest|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/NutritionOrder|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/ServiceRequest|4.0.1]]}
","Fulfills plan, proposal or order","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.","","Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.","","","","","","","",,,,,"",,,,"Observation.basedOn",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.partOf","Observation.partOf","","Container
","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/MedicationAdministration|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/MedicationDispense|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/MedicationStatement|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Procedure|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Immunization|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/ImagingStudy|4.0.1]]}
","Part of referenced event","A larger event of which this particular Observation is a component or step.  For example,  an observation as part of a procedure.","To link an Observation to an Encounter use `encounter`.  See the  [Notes](http://hl7.org/fhir/R4/observation.html#obsgrouping) below for guidance on referencing another Observation.","","","","","","","","",,,,,"",,,,"Observation.partOf",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.status","Observation.status","","","",1,1,"","Y","Y","code {[]} {[]}
","registered | preliminary | final | amended +","The status of the result value.","This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","Need to track the status of individual results. Some results are finalized before the whole report is finalized.","","","","","","","",,"required","Codes providing the status of an observation.","http://hl7.org/fhir/ValueSet/observation-status|4.0.1","",,,,"Observation.status",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.category","Observation.category","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Classification of  type of observation","A code that classifies the general type of observation being made.","In addition to the required category valueset, this element allows various categorization schemes based on the owner’s 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.","Used for filtering what observations are retrieved and displayed.","","","","","","","",,"preferred","Codes for high level observation categories.","http://hl7.org/fhir/ValueSet/observation-category|4.0.1","",,,,"Observation.category",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code","Observation.code","","Name
","",1,1,"","","Y","CodeableConcept {[]} {[]}
","Observation code. Note that when the observation is an individual observation (singular) LOINC should be used. If, however, the Observation is a grouping (e.g. vital-signs) the code can be from SNOMED CT e.g. `122869004`. See https://fhir-ig.digital.health.nz/sdhr/Observation-ObservationVitalSignsExample.html for example","Describes what was observed. Sometimes this is called the observation ""name"".","*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.","Knowing what kind of observation is being made is essential to understanding the observation.","","","","","","","",,"preferred","","http://hl7.org/fhir/ValueSet/observation-codes","",,,,"Observation.code",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.id","Observation.code.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.code.extension","Observation.code.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.code.coding","Observation.code.coding","","","",0,*,"","","Y","Coding {[]} {[]}
","Code defined by a terminology system","A reference to a code defined by a terminology system.","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.","Allows for alternative encodings within a code system, and translations to other code systems.","","","","","","","",,,,,"",,,,"CodeableConcept.coding",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.coding.id","Observation.code.coding.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.code.coding.extension","Observation.code.coding.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.code.coding.system","Observation.code.coding.system","","","",0,1,"","","Y","uri {[]} {[]}
","Identity of the terminology system","The identification of the code system that defines the meaning of the symbol in the code.","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.","Need to be unambiguous about the source of the definition of the symbol.","","","","","","","",,,,,"",,,,"Coding.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.coding.version","Observation.code.coding.version","","","",0,1,"","","Y","string {[]} {[]}
","Version of the system - if relevant","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.","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.","","","","","","","","",,,,,"",,,,"Coding.version",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.coding.code","Observation.code.coding.code","","","",0,1,"","","Y","code {[]} {[]}
","Symbol in syntax defined by the system","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).","","Need to refer to a particular code in the system.","","","","","","","",,,,,"",,,,"Coding.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.coding.display","Observation.code.coding.display","","","",0,1,"","","Y","string {[]} {[]}
","Representation defined by the system","A representation of the meaning of the code in the system, following the rules of the system.","","Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.","","","","","","","",,,,,"",,,,"Coding.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.coding.userSelected","Observation.code.coding.userSelected","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates that the value has been selected by a system user","This field is used to maintain the code as selected by the source systems end user. For example, where a patient management system uses local codes or a non-common code set to record a substance or allergen this field indicates that the value is as selected by the system user. Some level of clinical interpretation may be required.","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.","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.","","","","","","","",,,,,"",,,,"Coding.userSelected",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.code.text","Observation.code.text","","","",0,1,"","","Y","string {[]} {[]}
","Plain text representation of the concept","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.","Very often the text is the same as a displayName of one of the codings.","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.","","","","","","","",,,,,"",,,,"CodeableConcept.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.subject","Observation.subject","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient]]}
","National Health Identifier for the health consumer","National Health Identifier for the health consumer","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.","Observations have no value if you don't know who or what they're about.","","","","","","","",,,,,"",,,,"Observation.subject",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.subject.id","Observation.subject.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.subject.extension","Observation.subject.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.subject.reference","Observation.subject.reference","","","",1,1,"","","Y","string {[]} {[]}
","Must be an absolute URL reference to the patient on the NHI system. See constraints for details.","A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.","Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure ""/[type]/[id]"" then it should be assumed that the reference is to a FHIR RESTful server.","","","","","","","","",,,,,"",,,,"Reference.reference",0,1,"ref-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
nhi-url-format:Reference must be an NHI Patient URL with format https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/ZZZ1111 or ZZZ11AA {matches('^https://api.hip.digital.health.nz/fhir/nhi/v1/Patient/[A-Z]{3}([0-9]{4}|[0-9]{2}[A-Z]{2})$')}"
"SDHRObservation","Observation.subject.type","Observation.subject.type","","","",1,1,"","","Y","uri {[]} {[]}
","Type the reference refers to (e.g. ""Patient"")","The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. ""Patient"" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).","This element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.","","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""Patient""/>","","","",,"extensible","Aa resource (or, for logical models, the URI of the logical model).","http://hl7.org/fhir/ValueSet/resource-types|4.0.1","",,,,"Reference.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.subject.identifier","Observation.subject.identifier","","","",0,1,"","","Y","Identifier {[]} {[]}
","Logical reference, when literal reference is not known","An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.","When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. 

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).","","","","","","","","",,,,,"",,,,"Reference.identifier",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.subject.display","Observation.subject.display","","","",0,1,"","","Y","string {[]} {[]}
","Text alternative for the resource","Plain text narrative that identifies the resource in addition to the resource reference.","This is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.","","","","","","","","",,,,,"",,,,"Reference.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.focus","Observation.focus","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Resource|4.0.1]]}
","What the observation is about, when it is not about the subject of record","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.","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/R4/extension-observation-focuscode.html).","","","","","","","","",,,,,"",,,,"Observation.focus",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.encounter","Observation.encounter","","Context
","",0,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1]]}
","Healthcare event during which this observation is made","The healthcare event  (e.g. a patient and healthcare provider interaction) during which this observation is made.","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).","For some observations it may be important to know the link between an observation and a particular encounter.","","","","","","","",,,,,"",,,,"Observation.encounter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.effective[x]","Observation.effective[x]","","Occurrence
","",1,1,"","","Y","dateTime {[]} {[]}
Period {[]} {[]}Timing {[]} {[]}instant {[]} {[]}","Date and time/time-period the measurement was obtained","Date and time/time-period the measurement was obtained","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/R4/datatypes.html#timing) datatype which allow the measurement to be tied to regular life events.","Knowing when an observation was deemed true is important to its relevance as well as determining trends.","","","","","","","",,,,,"",,,,"Observation.effective[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.issued","Observation.issued","","","",0,1,"","","Y","instant {[]} {[]}
","Date/Time this version was made available","The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified.","For Observations that don’t require review and verification, it may be the same as the [`lastUpdated` ](http://hl7.org/fhir/R4/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’t require the new version to be reviewed and verified again.","","","","","","","","",,,,,"",,,,"Observation.issued",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.performer","Observation.performer","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/CareTeam|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1]]}
","Preferred - an HPI Practitioner URL with format https://api.hip.digital.health.nz/fhir/hpi/v1/Practitioner/11AAAA","Who was responsible for asserting the observed value as ""true"".","","May give a degree of confidence in the observation and also indicates where follow-up questions should be directed.","","","","","","","",,,,,"",,,,"Observation.performer",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.value[x]","Observation.value[x]","","","",0,1,"","","Y","Quantity {[]} {[]}
CodeableConcept {[]} {[]}string {[]} {[]}boolean {[]} {[]}integer {[]} {[]}Range {[]} {[]}Ratio {[]} {[]}SampledData {[]} {[]}time {[]} {[]}dateTime {[]} {[]}Period {[]} {[]}","Actual result","The information determined as a result of making the observation, if the information has a simple value.","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/R4/observation.html#notes) below.","An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","","","","","","","",,,,,"",,,,"Observation.value[x]",0,1,"obs-7
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.dataAbsentReason","Observation.dataAbsentReason","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Why the result is missing","Provides a reason why the expected value in the element Observation.value[x] is missing.","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"".   

The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values.  For example, the dataAbsentReason code ""error"" could be used when the measurement was not completed. 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.","For many results it is necessary to handle exceptional values in measurements.","","","","","","","",,"extensible","Codes specifying why the result (`Observation.value[x]`) is missing.","http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1","",,,,"Observation.dataAbsentReason",0,1,"obs-6
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.interpretation","Observation.interpretation","","Abnormal Flag
","",0,*,"","","","CodeableConcept {[]} {[]}
","High, low, normal, etc.","A categorical assessment of an observation value.  For example, high, low, normal.","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.","For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","","","","","","","",,"extensible","Codes identifying interpretations of observations.","http://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1","",,,,"Observation.interpretation",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.note","Observation.note","","","",0,*,"","","","Annotation {[]} {[]}
","Comments about the observation","Comments about the observation or the results.","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.","Need to be able to provide free text additional information.","","","","","","","",,,,,"",,,,"Observation.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.bodySite","Observation.bodySite","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Code for the body site affected by the problem (if applicable)","Code for the body site affected by the problem (if applicable)","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.   

If 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/R4/extension-bodysite.html).","","","","","","","","",,"example","Codes describing anatomical locations. May include laterality.","http://hl7.org/fhir/ValueSet/body-site|4.0.1","",,,,"Observation.bodySite",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.method","Observation.method","","","",0,1,"","","","CodeableConcept {[]} {[]}
","How it was done","Indicates the mechanism used to perform the observation.","Only used if not implicit in code for Observation.code.","In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results.","","","","","","","",,"example","Methods for simple observations.","http://hl7.org/fhir/ValueSet/observation-methods|4.0.1","",,,,"Observation.method",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.specimen","Observation.specimen","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Specimen|4.0.1]]}
","Specimen used for this observation","The specimen that was used when this observation was made.","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).","","","","","","","","",,,,,"",,,,"Observation.specimen",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.device","Observation.device","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Device|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/DeviceMetric|4.0.1]]}
","(Measurement) Device","The device used to generate the observation data.","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.","","","","","","","","",,,,,"",,,,"Observation.device",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange","Observation.referenceRange","","","",0,*,"","","","BackboneElement {[]} {[]}
","Provides guide for interpretation","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.","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.","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.","","","","","","","",,,,,"",,,,"Observation.referenceRange",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
obs-3:Must have at least a low or a high or text {low.exists() or high.exists() or text.exists()}"
"SDHRObservation","Observation.referenceRange.id","Observation.referenceRange.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.referenceRange.extension","Observation.referenceRange.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.referenceRange.modifierExtension","Observation.referenceRange.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.referenceRange.low","Observation.referenceRange.low","","","",0,1,"","","","Quantity {[CanonicalType[http://hl7.org/fhir/StructureDefinition/SimpleQuantity|4.0.1]]} {[]}
","Low Range, if relevant","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).","","","","","","","","","",,,,,"",,,,"Observation.referenceRange.low",0,1,"obs-3
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange.high","Observation.referenceRange.high","","","",0,1,"","","","Quantity {[CanonicalType[http://hl7.org/fhir/StructureDefinition/SimpleQuantity|4.0.1]]} {[]}
","High Range, if relevant","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).","","","","","","","","","",,,,,"",,,,"Observation.referenceRange.high",0,1,"obs-3
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange.type","Observation.referenceRange.type","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Reference range qualifier","Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.","This SHOULD be populated if there is more than one range.  If this element is not present then the normal range is assumed.","Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc.,  - for proper interpretation.","","","","","","","",,"preferred","Code for the meaning of a reference range.","http://hl7.org/fhir/ValueSet/referencerange-meaning|4.0.1","",,,,"Observation.referenceRange.type",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange.appliesTo","Observation.referenceRange.appliesTo","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Reference range population","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.","This SHOULD be populated if there is more than one range.  If this element is not present then the normal population is assumed.","Need to be able to identify the target population for proper interpretation.","","","","","","","",,"example","Codes identifying the population the reference range applies to.","http://hl7.org/fhir/ValueSet/referencerange-appliesto|4.0.1","",,,,"Observation.referenceRange.appliesTo",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange.age","Observation.referenceRange.age","","","",0,1,"","","","Range {[]} {[]}
","Applicable age range, if relevant","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.","","Some analytes vary greatly over age.","","","","","","","",,,,,"",,,,"Observation.referenceRange.age",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.referenceRange.text","Observation.referenceRange.text","","","",0,1,"","","","string {[]} {[]}
","Text based reference range in an observation","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"".","","","","","","","","","",,,,,"",,,,"Observation.referenceRange.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.hasMember","Observation.hasMember","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/MolecularSequence|4.0.1]]}
","Related resource that belongs to the Observation group","This observation is a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.","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/R4/observation.html#obsgrouping) below.  Note that a system may calculate results from [QuestionnaireResponse](http://hl7.org/fhir/R4/questionnaireresponse.html)  into a final score and represent the score as an Observation.","","","","","","","","",,,,,"",,,,"Observation.hasMember",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.derivedFrom","Observation.derivedFrom","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/DocumentReference|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/ImagingStudy|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Media|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|4.0.1], CanonicalType[http://hl7.org/fhir/StructureDefinition/MolecularSequence|4.0.1]]}
","Related measurements the observation is made from","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.","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/R4/observation.html#obsgrouping) below.","","","","","","","","",,,,,"",,,,"Observation.derivedFrom",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component","Observation.component","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Component results","Some observations have multiple component observations.  These component observations are expressed as separate code value pairs that share the same attributes.  Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.","For a discussion on the ways Observations can be assembled in groups together see [Notes](http://hl7.org/fhir/R4/observation.html#notes) below.","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.","","","","","","","",,,,,"",,,,"Observation.component",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.id","Observation.component.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.component.extension","Observation.component.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.component.modifierExtension","Observation.component.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","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).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.component.code","Observation.component.code","","","",1,1,"","","Y","CodeableConcept {[]} {[]}
","Type of component observation (code / type)","Describes what was observed. Sometimes this is called the observation ""code"".","*All* code-value and  component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.","Knowing what kind of observation is being made is essential to understanding the observation.","","","","","","","",,"preferred","","http://hl7.org/fhir/ValueSet/observation-codes","",,,,"Observation.component.code",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.id","Observation.component.code.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.component.code.extension","Observation.component.code.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.component.code.coding","Observation.component.code.coding","","","",0,*,"","","Y","Coding {[]} {[]}
","Code defined by a terminology system","A reference to a code defined by a terminology system.","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.","Allows for alternative encodings within a code system, and translations to other code systems.","","","","","","","",,,,,"",,,,"CodeableConcept.coding",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.coding.id","Observation.component.code.coding.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"SDHRObservation","Observation.component.code.coding.extension","Observation.component.code.coding.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","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.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"SDHRObservation","Observation.component.code.coding.system","Observation.component.code.coding.system","","","",0,1,"","","Y","uri {[]} {[]}
","Identity of the terminology system","The identification of the code system that defines the meaning of the symbol in the code.","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.","Need to be unambiguous about the source of the definition of the symbol.","","","","","","","",,,,,"",,,,"Coding.system",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.coding.version","Observation.component.code.coding.version","","","",0,1,"","","Y","string {[]} {[]}
","Version of the system - if relevant","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.","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.","","","","","","","","",,,,,"",,,,"Coding.version",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.coding.code","Observation.component.code.coding.code","","","",0,1,"","","Y","code {[]} {[]}
","Symbol in syntax defined by the system","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).","","Need to refer to a particular code in the system.","","","","","","","",,,,,"",,,,"Coding.code",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.coding.display","Observation.component.code.coding.display","","","",0,1,"","","Y","string {[]} {[]}
","Representation defined by the system","A representation of the meaning of the code in the system, following the rules of the system.","","Need to be able to carry a human-readable meaning of the code for readers that do not know  the system.","","","","","","","",,,,,"",,,,"Coding.display",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.coding.userSelected","Observation.component.code.coding.userSelected","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates that the value has been selected by a system user","This field is used to maintain the code as selected by the source systems end user. For example, where a patient management system uses local codes or a non-common code set to record a substance or allergen this field indicates that the value is as selected by the system user. Some level of clinical interpretation may be required.","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.","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.","","","","","","","",,,,,"",,,,"Coding.userSelected",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.code.text","Observation.component.code.text","","","",0,1,"","","Y","string {[]} {[]}
","Plain text representation of the concept","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.","Very often the text is the same as a displayName of one of the codings.","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.","","","","","","","",,,,,"",,,,"CodeableConcept.text",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.value[x]","Observation.component.value[x]","","","",0,1,"","","Y","Quantity {[]} {[]}
CodeableConcept {[]} {[]}string {[]} {[]}boolean {[]} {[]}integer {[]} {[]}Range {[]} {[]}Ratio {[]} {[]}SampledData {[]} {[]}time {[]} {[]}dateTime {[]} {[]}Period {[]} {[]}","Actual component result","The information determined as a result of making the observation, if the information has a simple value.","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/R4/observation.html#notes) below.","An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations.","","","","","","","",,,,,"",,,,"Observation.component.value[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.dataAbsentReason","Observation.component.dataAbsentReason","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Why the component result is missing","Provides a reason why the expected value in the element Observation.component.value[x] is missing.","""Null"" or exceptional values can be represented two ways in FHIR Observations.  One way is to simply include them in the value set and represent the exceptions in the value.  For example, measurement values for a serology test could be  ""detected"", ""not detected"", ""inconclusive"", or  ""test not done"". 

The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values.  For example, the dataAbsentReason code ""error"" could be used when the measurement was not completed.  Because of these options, use-case agreements are required to interpret general observations for exceptional values.","For many results it is necessary to handle exceptional values in measurements.","","","","","","","",,"extensible","Codes specifying why the result (`Observation.value[x]`) is missing.","http://hl7.org/fhir/ValueSet/data-absent-reason|4.0.1","",,,,"Observation.component.dataAbsentReason",0,1,"obs-6
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.interpretation","Observation.component.interpretation","","Abnormal Flag
","",0,*,"","","","CodeableConcept {[]} {[]}
","High, low, normal, etc.","A categorical assessment of an observation value.  For example, high, low, normal.","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.","For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result.","","","","","","","",,"extensible","Codes identifying interpretations of observations.","http://hl7.org/fhir/ValueSet/observation-interpretation|4.0.1","",,,,"Observation.component.interpretation",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"SDHRObservation","Observation.component.referenceRange","Observation.component.referenceRange","","","",0,*,"","","","null {[]} {[]}
","Provides guide for interpretation of component result","Guidance on how to interpret the value by comparison to a normal or recommended range.","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.","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.","","","","","","","",,,,,"",,,,"Observation.component.referenceRange",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"facility-participation-extension","Extension","Extension","","","",0,*,"","","","null {[]} {[]}
","Facility Participation","Indicates whether the patient has opted out or opted in to participation at the facility. If opted out, no records will be shared from that facility.","","","","","","","","","",,,,,"",,,,"Extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"facility-participation-extension","Extension.id","Extension.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"facility-participation-extension","Extension.extension","Extension.extension","","","",0,0,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"facility-participation-extension","Extension.url","Extension.url","","","",1,1,"","","","uri {[]} {[]}
","identifies the meaning of the extension","Source of the definition for the extension code - a logical name or a URL.","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.","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/facility-participation-extension""/>","","","","",,,,,"",,,,"Extension.url",1,1,"",""
"facility-participation-extension","Extension.value[x]","Extension.value[x]","","","",1,1,"","","","CodeableConcept {[]} {[]}
","Value of extension","Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).","","","","","","","","","",,,,,"","type:$this}
","",,"closed","Extension.value[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"facility-participation-extension","Extension.value[x]:valueCodeableConcept","Extension.value[x]","valueCodeableConcept","","",1,1,"","","","CodeableConcept {[]} {[]}
","Use sdhr-facility-opt-out if the patient has opted out, sdhr-facility-opt-in if the patient has opted in","Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).","","","","","","","","","",,"required","","https://fhir-ig.digital.health.nz/sdhr/ValueSet/sdhr-participation-reason-valueset","",,,,"Extension.value[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"hnz-sdhr-client-last-updated-extension","Extension","Extension","","","",0,*,"","","","null {[]} {[]}
","Client Last Updated","Extension to record the last time a resource was updated by the source system. When consuming applications are writing data to the SDHR API they can use this extension to record the `LastUpdated` timestamp in their system","","","","","","","","","",,,,,"",,,,"Extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"hnz-sdhr-client-last-updated-extension","Extension.id","Extension.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"hnz-sdhr-client-last-updated-extension","Extension.extension","Extension.extension","","","",0,0,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"hnz-sdhr-client-last-updated-extension","Extension.url","Extension.url","","","",1,1,"","","","uri {[]} {[]}
","identifies the meaning of the extension","Source of the definition for the extension code - a logical name or a URL.","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.","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-client-last-updated-extension""/>","","","","",,,,,"",,,,"Extension.url",1,1,"",""
"hnz-sdhr-client-last-updated-extension","Extension.value[x]","Extension.value[x]","","","",0,1,"","","","dateTime {[]} {[]}
","Value of extension","Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).","","","","","","","","","",,,,,"",,,,"Extension.value[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"hnz-sdhr-highlighted-extension","Extension","Extension","","","",0,*,"","","","null {[]} {[]}
","HNZ SDHR Highlighted","Extension to indicate that a resource should be highlighted in the user interface. This is used to indicate that the resource is important and should be highlighted in a user interface.","","","","","","","","","",,,,,"",,,,"Extension",0,*,"ele-1
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"hnz-sdhr-highlighted-extension","Extension.id","Extension.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"",""
"hnz-sdhr-highlighted-extension","Extension.extension","Extension.extension","","","",0,0,"","","","Extension {[]} {[]}
","Extension","An Extension","","","","","","","","","",,,,,"","value:url}
","Extensions are always sliced by (at least) url",,"open","Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}"
"hnz-sdhr-highlighted-extension","Extension.url","Extension.url","","","",1,1,"","","","uri {[]} {[]}
","identifies the meaning of the extension","Source of the definition for the extension code - a logical name or a URL.","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.","","","","<valueUri xmlns=""http://hl7.org/fhir"" value=""https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/hnz-sdhr-highlighted-extension""/>","","","","",,,,,"",,,,"Extension.url",1,1,"",""
"hnz-sdhr-highlighted-extension","Extension.value[x]","Extension.value[x]","","","",0,1,"","","","boolean {[]} {[]}
","Value of extension","Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).","","","","","","","","","",,,,,"",,,,"Extension.value[x]",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
