Resource JSON
You can render the JSON of a resource. We remove the narrative before parsing the JSON, because there is no added value of seeing that in it's source form.
{
--- We have skipped the narrative for better readability of the resource ---
},
{
{
},
{
}
]
}
],
"description": "The US Core Patient Profile meets the U.S. Core Data for Interoperability (USCDI) v2 'Patient Demographics' requirements. This profile sets minimum expectations for the Patient resource to record, search, and fetch basic demographics and other administrative information about an individual patient. It identifies which core elements, extensions, vocabularies and value sets **SHALL** be present in the resource when using this profile to promote interoperability and adoption through common implementation. It identifies which core elements, extensions, vocabularies and value sets **SHALL** be present in the resource when using this profile. It provides the floor for standards development for specific uses cases.",
],
"copyright": "Used by permission of HL7 International, all rights reserved Creative Commons License",
{
},
{
},
{
},
{
},
{
}
],
{
"SubjectOfCare Client Resident"
],
},
{
},
{
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
},
{
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
},
{
},
{
{
},
{
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
},
{
"human": "Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.",
"expression": "(name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
"xpath": "(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and not(/f:name/f:family or /f:name/f:given)) or (not(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason') and (/f:name/f:family or /f:name/f:given))"
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
},
],
{
}
],
},
{
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
},
{
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
},
],
{
}
],
{
},
{
},
{
}
],
}
},
{
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"narrative",
"html",
"xhtml",
"display"
],
},
],
{
}
],
]
},
{
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
]
},
{
},
},
],
{
},
{
}
],
},
{
"definition": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the [CDC Race and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories:\n\n - American Indian or Alaska Native\n - Asian\n - Black or African American\n - Native Hawaiian or Other Pacific Islander\n - White.",
},
{
}
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the [CDC ethnicity and Ethnicity Code Set Version 1.0](http://www.cdc.gov/phin/resources/vocabulary/index.html) which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino.",
},
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
]
}
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "A code classifying the person's sex assigned at birth as specified by the [Office of the National Coordinator for Health IT (ONC)](https://www.healthit.gov/newsroom/about-onc).",
"comment": "The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.",
},
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
]
}
],
"ele-1"
],
{
},
{
}
],
{
},
{
},
{
}
]
},
{
},
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
]
}
],
"ele-1"
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
},
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one.",
{
}
],
},
]
},
{
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "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.",
},
],
{
}
],
{
},
{
}
],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
},
{
},
{
}
]
},
{
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "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.",
},
],
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "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.",
},
],
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"comment": "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.",
},
{
}
],
{
}
],
{
},
{
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
}
]
},
{
"definition": "Whether this patient record is in active use. \nMany systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.\n\nIt is often used to filter patient lists to exclude inactive patients\n\nDeceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.",
"comment": "If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
},
],
"meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element",
{
}
],
"isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid",
{
},
{
},
{
}
]
},
{
"comment": "A patient may have multiple names with different uses or applicable periods. For animals, the name is a \"HumanName\" in the sense that is assigned and used by humans and has the same patterns.",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
},
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one",
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.",
"comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
},
],
{
}
],
]
},
{
"definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"surname"
],
},
],
"us-core-6"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.",
"first name",
"middle name"
],
},
],
"us-core-6"
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comment": "A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
},
],
"cpt-2"
],
{
}
],
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"comment": "Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
},
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one",
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
},
],
{
}
],
]
},
{
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comment": "The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a \"hard\" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex.",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date.",
},
],
{
}
],
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension \"patient-birthTime\" available that should be used where Time is required (such as in maternity/infant care systems).",
},
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
{
},
{
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
}
]
},
{
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
],
},
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"comment": "Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
},
],
],
{
}
],
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one",
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"comment": "The definition of Address states that \"address is intended to describe postal addresses, not physical locations\". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the [Location](http://hl7.org/fhir/R4/location.html#) resource).",
},
],
],
{
}
],
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.",
"comment": "Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.",
},
],
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
},
],
],
{
}
],
{
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"
},
{
},
{
},
{
},
{
}
]
},
{
"Municpality"
],
},
],
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
"comment": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"County"
],
},
],
],
{
}
],
]
},
{
"definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).",
"Province",
"Territory"
],
},
],
{
}
],
},
{
},
{
},
{
},
{
},
{
}
]
},
{
"Zip",
"Zip Code"
],
},
],
],
{
}
],
{
},
{
},
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
],
],
{
}
],
{
},
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
},
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).",
"comment": "Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
},
],
{
}
],
{
},
{
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
}
]
},
{
"comment": "Guidelines:\n* Use id photos, not clinical photos.\n* Limit dimensions to thumbnail.\n* Keep byte count low to ease resource updates.",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
{
}
],
"comment": "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
},
],
{
},
{
}
],
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
},
],
{
}
],
{
}
],
"description": "The nature of the relationship between a patient and a contact person for that patient.",
},
{
},
{
},
{
}
]
},
{
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"comment": "Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
},
],
{
}
],
{
},
{
}
],
},
{
},
{
},
{
}
]
},
{
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
},
{
}
],
"pat-1"
],
{
}
],
{
},
{
},
{
}
]
},
{
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
},
],
{
}
],
]
},
{
"definition": "A language which may be used to communicate with the patient about his or her health.",
"comment": "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements": "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.",
"comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
},
],
{
}
],
},
{
},
{
},
{
},
{
}
]
},
{
"definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
},
],
{
}
],
{
},
{
},
{
}
]
},
{
"comment": "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.\nMultiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a \"fly-in/fly-out\" worker that has the onsite GP also included with his home GP to remain aware of medical issues.\n\nJurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.",
"careProvider"
],
},
{
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/PractitionerRole"
]
}
],
{
}
],
{
},
{
},
{
}
]
},
{
"comment": "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
},
{
}
],
{
}
],
]
},
{
"requirements": "There are multiple use cases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and \n* Distribution of patient information across multiple servers.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because it might not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'",
]
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"extensions",
"user content"
],
},
],
{
},
{
}
],
]
},
{
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
"comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
},
{
{
}
],
"http://hl7.org/fhir/StructureDefinition/Patient",
"http://hl7.org/fhir/StructureDefinition/RelatedPerson"
]
}
],
{
}
],
{
},
{
},
{
}
]
},
{
},
],
{
}
],
{
}
],
},
]
}
]
},
{
{
"human": "Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.",
"expression": "(name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()",
"xpath": "(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and not(/f:name/f:family or /f:name/f:given)) or (not(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason') and (/f:name/f:family or /f:name/f:given))"
}
],
]
},
{
{
}
],
]
},
{
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
]
}
],
]
},
{
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
]
}
],
]
},
{
{
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity"
]
}
],
]
},
{
]
},
{
]
},
{
]
},
{
]
},
{
},
{
"us-core-6"
],
]
},
{
"us-core-6"
],
]
},
{
]
},
{
]
},
{
]
},
{
},
]
},
{
]
},
{
},
]
},
{
],
},
]
},
{
]
},
{
]
},
{
},
{
]
},
{
]
},
{
},
]
},
{
"Zip Code"
],
]
},
{
]
},
{
]
},
{
},
]
}
]
}
}