{
"description": "BSeR Patient",
"_filename": "StructureDefinition-PatientRole.json",
"package_name": "hl7.fhir.us.bser",
"date": "2019-03-27T07:29:43+11:00",
"derivation": "constraint",
"publisher": "Hi3 Solutions",
"fhirVersion": "3.0.1",
"name": "BSeR Patient",
"mapping": [ {
"uri": "http://unknown.org/Argonaut-DQ-DSTU2",
"name": "Argonaut-DQ-DSTU2",
"identity": "argonaut-dq-dstu2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://loinc.org",
"name": "LOINC code for the element",
"identity": "loinc"
} ],
"abstract": false,
"type": "Patient",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"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))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Patient",
"min": 0,
"definition": "The US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.",
"short": "US Core Patient Profile",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Patient[classCode=PAT]",
"identity": "rim"
}, {
"map": "ClinicalDocument.recordTarget.patientRole",
"identity": "cda"
}, {
"map": "administrative.individual",
"identity": "w5"
}, {
"map": "Patient",
"identity": "argonaut-dq-dstu2"
} ],
"mustSupport": false,
"alias": [ "SubjectOfCare Client Resident" ],
"max": "*",
"id": "Patient",
"base": {
"max": "*",
"min": 0,
"path": "Patient"
}
}, {
"path": "Patient.id",
"min": 0,
"definition": "MAY contain zero or one [0..1] id (CONF:4383-796).",
"short": "id",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Patient.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Patient.meta",
"min": 0,
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-795).",
"short": "meta",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Patient.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Patient.meta.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.meta.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Patient.meta.versionId",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"path": "Patient.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "Patient.meta.lastUpdated",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"path": "Patient.meta.profile",
"min": 1,
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole\" (CONF:4383-797).",
"short": "profile",
"type": [ {
"code": "uri"
} ],
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole",
"max": "1",
"id": "Patient.meta.profile",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"path": "Patient.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "Patient.meta.security",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "Patient.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags"
}
},
"max": "*",
"id": "Patient.meta.tag",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"path": "Patient.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Patient.implicitRules",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Patient.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Patient.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Patient.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Patient.text",
"condition": [ "dom-1" ],
"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 in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Patient.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Patient.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Patient.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"id": "1",
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Patient.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"mapping": [ {
"map": "Patient.extension",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
} ],
"mustSupport": true,
"sliceName": "race",
"max": "1",
"id": "Patient.extension:race",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"mapping": [ {
"map": "Patient.extension",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
} ],
"mustSupport": true,
"sliceName": "ethnicity",
"max": "1",
"id": "Patient.extension:ethnicity",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"mapping": [ {
"map": "Patient.extension",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "Extension",
"profile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
} ],
"mustSupport": true,
"sliceName": "birthsex",
"max": "1",
"id": "Patient.extension:birthsex",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Patient.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Patient.identifier",
"requirements": "Patients are almost always assigned specific numerical identifiers.",
"min": 1,
"definition": "SHALL contain at least one [1..*] identifier (CONF:4383-34).",
"short": "identifier",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": ".id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
}, {
"map": "Patient.identifier",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Patient.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Patient.identifier"
},
"isSummary": true
}, {
"path": "Patient.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.identifier.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "Patient.identifier.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "Patient.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 1,
"definition": "Such identifiers SHALL contain exactly one [1..1] type, which SHALL be selected from ValueSet Identifier-type http://hl7.org/fhir/ValueSet/identifier-type DYNAMIC (CONF:4383-39).",
"short": "type",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"max": "1",
"id": "Patient.identifier.type",
"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. \n\nWhere 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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "Patient.identifier.system",
"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.",
"min": 1,
"definition": "Such identifiers SHALL contain exactly one [1..1] system (CONF:4383-40).",
"short": "system",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
}, {
"map": "Patient.identifier.system",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.identifier.system",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"path": "Patient.identifier.value",
"min": 1,
"definition": "Such identifiers SHALL contain exactly one [1..1] value (CONF:4383-41).",
"short": "value",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
}, {
"map": "Patient.identifier.value",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.identifier.value",
"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/us/core/extension-rendered-value.html).",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "Patient.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "Patient.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Patient.identifier.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "Patient.active",
"requirements": "Need to be able to mark a patient record as not to be used because it was created in error.",
"min": 0,
"definition": "Whether this patient record is in active use.",
"isModifier": true,
"short": "Whether this patient's record is in active use",
"mapping": [ {
"map": "statusCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "Patient.active",
"comment": "Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient\n\nThis element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.active"
},
"isSummary": true
}, {
"path": "Patient.name",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.",
"min": 1,
"definition": "SHALL contain at least one [1..*] name (CONF:4383-54).",
"short": "name",
"mapping": [ {
"map": "PID-5, PID-9",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": ".patient.name",
"identity": "cda"
}, {
"map": "Patient.name",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "HumanName"
} ],
"mustSupport": true,
"max": "*",
"id": "Patient.name",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.name"
},
"isSummary": true
}, {
"path": "Patient.name.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.name.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.name.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.name.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.name.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 1,
"definition": "Such names SHALL contain exactly one [1..1] use, which SHALL be selected from ValueSet Name-use http://hl7.org/fhir/ValueSet/name-use DYNAMIC (CONF:4383-110).",
"isModifier": true,
"short": "use",
"mapping": [ {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"max": "1",
"id": "Patient.name.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isSummary": true
}, {
"path": "Patient.name.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the name.",
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.name.text",
"comment": "Can provide both a text representation and structured parts.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"isSummary": true
}, {
"path": "Patient.name.family",
"min": 1,
"definition": "Such names SHALL contain exactly one [1..1] family (CONF:4383-60).",
"short": "family",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
}, {
"map": "Patient.name.family",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "surname" ],
"max": "1",
"id": "Patient.name.family",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"isSummary": true
}, {
"path": "Patient.name.given",
"min": 1,
"definition": "Such names SHALL contain at least one [1..*] given (CONF:4383-61).",
"short": "given",
"mapping": [ {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
}, {
"map": "Patient.name.given",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "first name", "middle name" ],
"max": "*",
"id": "Patient.name.given",
"comment": "If only initials are recorded, they may be used in place of the full name. Not called \"first name\" since given names do not always come first.",
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"path": "Patient.name.prefix",
"min": 0,
"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.",
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.prefix",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"isSummary": true
}, {
"path": "Patient.name.suffix",
"min": 0,
"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.",
"short": "Parts that come after the name",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.name.suffix",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"isSummary": true
}, {
"path": "Patient.name.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"short": "Time period when name was/is in use",
"mapping": [ {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.name.period",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"isSummary": true
}, {
"path": "Patient.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "SHOULD contain zero or more [0..*] telecom (CONF:4383-35).",
"short": "telecom",
"mapping": [ {
"map": "PID-13, PID-14, PID-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": ".telecom",
"identity": "cda"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Patient.telecom",
"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 may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"base": {
"max": "*",
"min": 0,
"path": "Patient.telecom"
},
"isSummary": true
}, {
"path": "Patient.telecom.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.telecom.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.telecom.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.telecom.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.telecom.system",
"min": 1,
"definition": "The telecom, if present, SHALL contain exactly one [1..1] system, which SHALL be selected from ValueSet Contact-point-system http://hl7.org/fhir/ValueSet/contact-point-system DYNAMIC (CONF:4383-42).",
"short": "system",
"mapping": [ {
"map": "XTN.3",
"identity": "v2"
}, {
"map": "./scheme",
"identity": "rim"
}, {
"map": "./ContactPointType",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"max": "1",
"id": "Patient.telecom.system",
"condition": [ "cpt-2" ],
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.system"
},
"isSummary": true
}, {
"path": "Patient.telecom.value",
"requirements": "Need to support legacy numbers that are not in a tightly controlled format.",
"min": 1,
"definition": "The telecom, if present, SHALL contain exactly one [1..1] value (CONF:4383-43).",
"short": "value",
"mapping": [ {
"map": "XTN.1 (or XTN.12)",
"identity": "v2"
}, {
"map": "./url",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.telecom.value",
"comment": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.value"
},
"isSummary": true
}, {
"path": "Patient.telecom.use",
"requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min": 1,
"definition": "The telecom, if present, SHALL contain exactly one [1..1] use, which SHALL be selected from ValueSet Contact-point-use http://hl7.org/fhir/ValueSet/contact-point-use DYNAMIC (CONF:4383-44).",
"isModifier": true,
"short": "use",
"mapping": [ {
"map": "XTN.2 - but often indicated by field",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./ContactPointPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"max": "1",
"id": "Patient.telecom.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.use"
},
"isSummary": true
}, {
"path": "Patient.telecom.rank",
"min": 0,
"definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"short": "Specify preferred order of use (1 = highest)",
"mapping": [ {
"map": "n/a",
"identity": "v2"
}, {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Patient.telecom.rank",
"comment": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.rank"
},
"isSummary": true
}, {
"path": "Patient.telecom.period",
"min": 0,
"definition": "Time period when the contact point was/is in use.",
"short": "Time period when the contact point was/is in use",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.telecom.period",
"base": {
"max": "1",
"min": 0,
"path": "ContactPoint.period"
},
"isSummary": true
}, {
"path": "Patient.gender",
"requirements": "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] gender, which SHALL be selected from ValueSet Administrative-gender http://hl7.org/fhir/ValueSet/administrative-gender DYNAMIC (CONF:4383-55).",
"short": "gender",
"mapping": [ {
"map": "PID-8",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": ".patient.administrativeGenderCode",
"identity": "cda"
}, {
"map": "Patient.gender",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"max": "1",
"id": "Patient.gender",
"comment": "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a \"hard\" error.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.gender"
},
"isSummary": true
}, {
"path": "Patient.birthDate",
"requirements": "Age of the individual drives many clinical processes.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] birthDate (CONF:4383-56).",
"short": "birthDate",
"mapping": [ {
"map": "PID-7",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime",
"identity": "rim"
}, {
"map": ".patient.birthTime",
"identity": "cda"
}, {
"map": "21112-8",
"identity": "loinc"
}, {
"map": "Patient.birthDate",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "date"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.birthDate",
"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 maternaty/infant care systems).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.birthDate"
},
"isSummary": true
}, {
"path": "Patient.deceased[x]",
"requirements": "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min": 0,
"definition": "Indicates if the individual is deceased or not.",
"isModifier": true,
"short": "Indicates if the individual is deceased or not",
"mapping": [ {
"map": "PID-30 (bool) and PID-29 (datetime)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "dateTime"
} ],
"max": "1",
"id": "Patient.deceased[x]",
"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.\n\nThis 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.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.deceased[x]"
},
"isSummary": true
}, {
"path": "Patient.address",
"requirements": "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min": 0,
"definition": "SHOULD contain zero or more [0..*] address (CONF:4383-36).",
"short": "address",
"mapping": [ {
"map": "PID-11",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
}, {
"map": ".addr",
"identity": "cda"
} ],
"type": [ {
"code": "Address"
} ],
"max": "*",
"id": "Patient.address",
"comment": "Patient may have multiple addresses with different uses or applicable periods.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.address"
},
"isSummary": true
}, {
"path": "Patient.address.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.address.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.address.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.address.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.address.use",
"requirements": "Allows an appropriate address to be chosen from a list of many.",
"min": 0,
"definition": "The purpose of this address.",
"isModifier": true,
"short": "home | work | temp | old - purpose of this address",
"mapping": [ {
"map": "XAD.7",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./AddressPurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressUse"
} ],
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-use"
}
},
"max": "1",
"id": "Patient.address.use",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"example": [ {
"label": "General",
"valueCode": "home"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.use"
},
"isSummary": true
}, {
"path": "Patient.address.type",
"min": 0,
"definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"short": "postal | physical | both",
"mapping": [ {
"map": "XAD.18",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "address type parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AddressType"
} ],
"description": "The type of an address (physical / postal)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-type"
}
},
"max": "1",
"id": "Patient.address.type",
"example": [ {
"label": "General",
"valueCode": "both"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.type"
},
"isSummary": true
}, {
"path": "Patient.address.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "The address, if present, MAY contain zero or one [0..1] text (CONF:4383-111).",
"short": "text",
"mapping": [ {
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
}, {
"map": "address label parameter",
"identity": "vcard"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.address.text",
"comment": "Can provide both a text representation and parts.",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street, Erewhon 9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.text"
},
"isSummary": true
}, {
"path": "Patient.address.line",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 0,
"definition": "The address, if present, SHOULD contain zero or more [0..*] line (CONF:4383-45).",
"short": "line",
"mapping": [ {
"map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)",
"identity": "v2"
}, {
"map": "AD.part[parttype = AL]",
"identity": "rim"
}, {
"map": "street",
"identity": "vcard"
}, {
"map": "./StreetAddress (newline delimitted)",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Patient.address.line",
"example": [ {
"label": "General",
"valueString": "137 Nowhere Street"
} ],
"orderMeaning": "The order in which lines should appear in an address label",
"base": {
"max": "*",
"min": 0,
"path": "Address.line"
},
"isSummary": true
}, {
"path": "Patient.address.city",
"min": 0,
"definition": "The address, if present, SHOULD contain zero or one [0..1] city (CONF:4383-46).",
"short": "city",
"mapping": [ {
"map": "XAD.3",
"identity": "v2"
}, {
"map": "AD.part[parttype = CTY]",
"identity": "rim"
}, {
"map": "locality",
"identity": "vcard"
}, {
"map": "./Jurisdiction",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Municpality" ],
"max": "1",
"id": "Patient.address.city",
"example": [ {
"label": "General",
"valueString": "Erewhon"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.city"
},
"isSummary": true
}, {
"path": "Patient.address.district",
"min": 0,
"definition": "The name of the administrative area (county).",
"short": "District name (aka county)",
"mapping": [ {
"map": "XAD.9",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT | CPA]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "County" ],
"max": "1",
"id": "Patient.address.district",
"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.",
"example": [ {
"label": "General",
"valueString": "Madison"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.district"
},
"isSummary": true
}, {
"path": "Patient.address.state",
"min": 0,
"definition": "The address, if present, SHOULD contain zero or one [0..1] state (CONF:4383-47).",
"short": "state",
"mapping": [ {
"map": "XAD.4",
"identity": "v2"
}, {
"map": "AD.part[parttype = STA]",
"identity": "rim"
}, {
"map": "region",
"identity": "vcard"
}, {
"map": "./Region",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Province", "Territory" ],
"max": "1",
"id": "Patient.address.state",
"base": {
"max": "1",
"min": 0,
"path": "Address.state"
},
"isSummary": true
}, {
"path": "Patient.address.postalCode",
"min": 0,
"definition": "The address, if present, SHOULD contain zero or one [0..1] postalCode (CONF:4383-48).",
"short": "postalCode",
"mapping": [ {
"map": "XAD.5",
"identity": "v2"
}, {
"map": "AD.part[parttype = ZIP]",
"identity": "rim"
}, {
"map": "code",
"identity": "vcard"
}, {
"map": "./PostalIdentificationCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "Zip" ],
"max": "1",
"id": "Patient.address.postalCode",
"example": [ {
"label": "General",
"valueString": "9132"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.postalCode"
},
"isSummary": true
}, {
"path": "Patient.address.country",
"min": 1,
"definition": "The address, if present, SHALL contain exactly one [1..1] country, which SHALL be selected from CodeSystem ISO 3166 Part 1 Country Codes, 2nd Edition, Alpha-2 (urn:oid:1.0.3166.1.2.2) DYNAMIC (CONF:4383-49).",
"short": "country",
"mapping": [ {
"map": "XAD.6",
"identity": "v2"
}, {
"map": "AD.part[parttype = CNT]",
"identity": "rim"
}, {
"map": "country",
"identity": "vcard"
}, {
"map": "./Country",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Patient.address.country",
"comment": "ISO 3166 3 letter codes can be used in place of a full country name.",
"base": {
"max": "1",
"min": 0,
"path": "Address.country"
},
"isSummary": true
}, {
"path": "Patient.address.period",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"definition": "Time period when address was/is in use.",
"short": "Time period when address was/is in use",
"mapping": [ {
"map": "XAD.12 / XAD.13 + XAD.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.address.period",
"example": [ {
"label": "General",
"valuePeriod": {
"end": "2010-07-01T00:00:00+10:00",
"start": "2010-03-23T00:00:00+11:00"
}
} ],
"base": {
"max": "1",
"min": 0,
"path": "Address.period"
},
"isSummary": true
}, {
"path": "Patient.maritalStatus",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"definition": "This field contains a patient's most recent marital (civil) status.",
"short": "Marital (civil) status of a patient",
"mapping": [ {
"map": "PID-16",
"identity": "v2"
}, {
"map": "player[classCode=PSN]/maritalStatusCode",
"identity": "rim"
}, {
"map": ".patient.maritalStatusCode",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MaritalStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The domestic partnership status of a person.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/marital-status"
}
},
"max": "1",
"id": "Patient.maritalStatus",
"base": {
"max": "1",
"min": 0,
"path": "Patient.maritalStatus"
}
}, {
"path": "Patient.multipleBirth[x]",
"requirements": "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min": 0,
"definition": "Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).",
"short": "Whether patient is part of a multiple birth",
"mapping": [ {
"map": "PID-24 (bool), PID-25 (integer)",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
}, {
"code": "integer"
} ],
"max": "1",
"id": "Patient.multipleBirth[x]",
"comment": "Where the valueInteger is provided, the number is the birth number in the sequence.\nE.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3\nIf a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.multipleBirth[x]"
}
}, {
"path": "Patient.photo",
"requirements": "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the patient.",
"short": "Image of the patient",
"mapping": [ {
"map": "OBX-5 - needs a profile",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "Patient.photo",
"base": {
"max": "*",
"min": 0,
"path": "Patient.photo"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "pat-1",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)",
"severity": "error",
"expression": "name.exists() or telecom.exists() or address.exists() or organization.exists()"
} ],
"path": "Patient.contact",
"requirements": "Need to track people you can contact about the patient.",
"min": 0,
"definition": "A contact party (e.g. guardian, partner, friend) for the patient.",
"short": "A contact party (e.g. guardian, partner, friend) for the patient",
"mapping": [ {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Contact"
} ],
"max": "*",
"id": "Patient.contact",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact"
}
}, {
"path": "Patient.contact.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.contact.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.contact.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.contact.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.contact.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.contact.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Patient.contact.relationship",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"definition": "The nature of the relationship between the patient and the contact person.",
"short": "The kind of relationship",
"mapping": [ {
"map": "NK1-7, NK1-3",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ContactRelationship"
} ],
"description": "The nature of the relationship between a patient and a contact person for that patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-0131"
}
},
"max": "*",
"id": "Patient.contact.relationship",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.relationship"
}
}, {
"path": "Patient.contact.name",
"requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min": 0,
"definition": "A name associated with the contact person.",
"short": "A name associated with the contact person",
"mapping": [ {
"map": "NK1-2",
"identity": "v2"
}, {
"map": "name",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "HumanName"
} ],
"max": "1",
"id": "Patient.contact.name",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.name"
}
}, {
"path": "Patient.contact.telecom",
"requirements": "People have (primary) ways to contact them in some way such as phone, email.",
"min": 0,
"definition": "A contact detail for the person, e.g. a telephone number or an email address.",
"short": "A contact detail for the person",
"mapping": [ {
"map": "NK1-5, NK1-6, NK1-40",
"identity": "v2"
}, {
"map": "telecom",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Patient.contact.telecom",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.contact.telecom"
}
}, {
"path": "Patient.contact.address",
"requirements": "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min": 0,
"definition": "Address for the contact person.",
"short": "Address for the contact person",
"mapping": [ {
"map": "NK1-4",
"identity": "v2"
}, {
"map": "addr",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Address"
} ],
"max": "1",
"id": "Patient.contact.address",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.address"
}
}, {
"path": "Patient.contact.gender",
"requirements": "Needed to address the person correctly.",
"min": 0,
"definition": "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"short": "male | female | other | unknown",
"mapping": [ {
"map": "NK1-15",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"max": "1",
"id": "Patient.contact.gender",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.gender"
}
}, {
"path": "Patient.contact.organization",
"requirements": "For guardians or business related contacts, the organization is relevant.",
"min": 0,
"definition": "Organization on behalf of which the contact is acting or for which the contact is working.",
"short": "Organization that is associated with the contact",
"mapping": [ {
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41",
"identity": "v2"
}, {
"map": "scoper",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Patient.contact.organization",
"condition": [ "pat-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.organization"
}
}, {
"path": "Patient.contact.period",
"min": 0,
"definition": "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"short": "The period during which this contact person or organization is valid to be contacted relating to this patient",
"mapping": [ {
"map": "effectiveTime",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Patient.contact.period",
"base": {
"max": "1",
"min": 0,
"path": "Patient.contact.period"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Patient.animal",
"requirements": "Many clinical systems are extended to care for animal patients as well as human.",
"min": 0,
"definition": "This patient is known to be an animal.",
"isModifier": true,
"short": "This patient is known to be an animal (non-human)",
"mapping": [ {
"map": "player[classCode=ANM]",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
}, {
"map": "Patient.animal",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "Animal"
} ],
"max": "0",
"id": "Patient.animal",
"comment": "The animal element is labeled \"Is Modifier\" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal"
},
"isSummary": true
}, {
"path": "Patient.animal.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.animal.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.animal.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.animal.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.animal.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.animal.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Patient.animal.species",
"requirements": "Need to know what kind of animal.",
"min": 1,
"definition": "Identifies the high level taxonomic categorization of the kind of animal.",
"short": "E.g. Dog, Cow",
"mapping": [ {
"map": "PID-35",
"identity": "v2"
}, {
"map": "code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalSpecies"
} ],
"description": "The species of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-species"
}
},
"max": "1",
"id": "Patient.animal.species",
"comment": "If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word \"Hereford\" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for \"Hereford Cattle Breed\" does.).",
"base": {
"max": "1",
"min": 1,
"path": "Patient.animal.species"
},
"isSummary": true
}, {
"path": "Patient.animal.breed",
"requirements": "May need to know the specific kind within the species.",
"min": 0,
"definition": "Identifies the detailed categorization of the kind of animal.",
"short": "E.g. Poodle, Angus",
"mapping": [ {
"map": "PID-37",
"identity": "v2"
}, {
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalBreed"
} ],
"description": "The breed of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-breeds"
}
},
"max": "1",
"id": "Patient.animal.breed",
"comment": "Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal.breed"
},
"isSummary": true
}, {
"path": "Patient.animal.genderStatus",
"requirements": "Gender status can affect housing and animal behavior.",
"min": 0,
"definition": "Indicates the current state of the animal's reproductive organs.",
"short": "E.g. Neutered, Intact",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "genderStatusCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AnimalGenderStatus"
} ],
"description": "The state of the animal's reproductive organs.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-genderstatus"
}
},
"max": "1",
"id": "Patient.animal.genderStatus",
"base": {
"max": "1",
"min": 0,
"path": "Patient.animal.genderStatus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Patient.communication",
"requirements": "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min": 0,
"definition": "SHOULD contain zero or one [0..1] communication (CONF:4383-107).",
"short": "communication",
"mapping": [ {
"map": "LanguageCommunication",
"identity": "rim"
}, {
"map": "patient.languageCommunication",
"identity": "cda"
}, {
"map": "Patient.communication",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"id": "Patient.communication",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.communication"
}
}, {
"path": "Patient.communication.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.communication.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.communication.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.communication.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.communication.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.communication.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Patient.communication.language",
"requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min": 1,
"definition": "The communication, if present, SHALL contain exactly one [1..1] language, which SHALL be selected from ValueSet Languages http://hl7.org/fhir/ValueSet/languages DYNAMIC (CONF:4383-108).",
"short": "language",
"mapping": [ {
"map": "PID-15, LAN-2",
"identity": "v2"
}, {
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code",
"identity": "rim"
}, {
"map": ".languageCode",
"identity": "cda"
}, {
"map": "Patient.communication.language",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Patient.communication.language",
"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.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.communication.language"
}
}, {
"path": "Patient.communication.preferred",
"requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min": 0,
"definition": "The communication, if present, SHALL contain zero or one [0..1] preferred (CONF:4383-109).",
"short": "preferred",
"mapping": [ {
"map": "PID-15",
"identity": "v2"
}, {
"map": "preferenceInd",
"identity": "rim"
}, {
"map": ".preferenceInd",
"identity": "cda"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Patient.communication.preferred",
"comment": "This language is specifically identified for communicating healthcare information.",
"base": {
"max": "1",
"min": 0,
"path": "Patient.communication.preferred"
}
}, {
"path": "Patient.generalPractitioner",
"min": 0,
"definition": "Patient's nominated care provider.",
"short": "Patient's nominated primary care provider",
"mapping": [ {
"map": "PD1-4",
"identity": "v2"
}, {
"map": "subjectOf.CareEvent.performer.AssignedEntity",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"alias": [ "careProvider" ],
"max": "*",
"id": "Patient.generalPractitioner",
"comment": "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles.\n\nIt 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.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.generalPractitioner"
}
}, {
"path": "Patient.managingOrganization",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"definition": "Organization that is the custodian of the patient record.",
"short": "Organization that is the custodian of the patient record",
"mapping": [ {
"map": "scoper",
"identity": "rim"
}, {
"map": ".providerOrganization",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Patient.managingOrganization",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Patient.managingOrganization"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Patient.link",
"requirements": "There are multiple usecases: \n\n* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.",
"min": 0,
"definition": "Link to another patient resource that concerns the same actual patient.",
"isModifier": true,
"short": "Link to another patient resource that concerns the same actual person",
"mapping": [ {
"map": "outboundLink",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Patient.link",
"comment": "There is no assumption that linked patient records have mutual links. \n\nThis element is labelled as a modifier because it may 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'.",
"base": {
"max": "*",
"min": 0,
"path": "Patient.link"
},
"isSummary": true
}, {
"path": "Patient.link.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Patient.link.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Patient.link.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Patient.link.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Patient.link.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Patient.link.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Patient.link.other",
"min": 1,
"definition": "The other patient resource that the link refers to.",
"short": "The other patient or related person resource that the link refers to",
"mapping": [ {
"map": "PID-3, MRG-1",
"identity": "v2"
}, {
"map": "id",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"max": "1",
"id": "Patient.link.other",
"comment": "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.other"
},
"isSummary": true
}, {
"path": "Patient.link.type",
"min": 1,
"definition": "The type of link between this patient resource and another patient resource.",
"short": "replaced-by | replaces | refer | seealso - type of link",
"mapping": [ {
"map": "typeCode",
"identity": "rim"
}, {
"map": "n/a",
"identity": "cda"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "LinkType"
} ],
"description": "The type of link between this patient resource and another patient resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/link-type"
}
},
"max": "1",
"id": "Patient.link.type",
"base": {
"max": "1",
"min": 1,
"path": "Patient.link.type"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "ba9b325f-95f9-4048-9169-f58860f7acbb",
"kind": "resource",
"url": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole",
"context": [ "Patient" ],
"version": "0.2.0",
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient"
}, {
"id": "Patient.id",
"max": "1",
"min": 0,
"path": "Patient.id",
"short": "id",
"definition": "MAY contain zero or one [0..1] id (CONF:4383-796)."
}, {
"id": "Patient.meta",
"max": "1",
"min": 0,
"path": "Patient.meta",
"short": "meta",
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-795)."
}, {
"id": "Patient.meta.profile",
"max": "1",
"min": 1,
"path": "Patient.meta.profile",
"short": "profile",
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole\" (CONF:4383-797).",
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/PatientRole"
}, {
"id": "Patient.identifier",
"max": "*",
"min": 1,
"path": "Patient.identifier",
"short": "identifier",
"definition": "SHALL contain at least one [1..*] identifier (CONF:4383-34)."
}, {
"id": "Patient.identifier.type",
"max": "1",
"min": 1,
"path": "Patient.identifier.type",
"short": "type",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"definition": "Such identifiers SHALL contain exactly one [1..1] type, which SHALL be selected from ValueSet Identifier-type http://hl7.org/fhir/ValueSet/identifier-type DYNAMIC (CONF:4383-39)."
}, {
"id": "Patient.identifier.system",
"max": "1",
"min": 1,
"path": "Patient.identifier.system",
"short": "system",
"definition": "Such identifiers SHALL contain exactly one [1..1] system (CONF:4383-40)."
}, {
"id": "Patient.identifier.value",
"max": "1",
"min": 1,
"path": "Patient.identifier.value",
"short": "value",
"definition": "Such identifiers SHALL contain exactly one [1..1] value (CONF:4383-41)."
}, {
"id": "Patient.name",
"max": "*",
"min": 1,
"path": "Patient.name",
"short": "name",
"definition": "SHALL contain at least one [1..*] name (CONF:4383-54)."
}, {
"id": "Patient.name.use",
"max": "1",
"min": 1,
"path": "Patient.name.use",
"short": "use",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"definition": "Such names SHALL contain exactly one [1..1] use, which SHALL be selected from ValueSet Name-use http://hl7.org/fhir/ValueSet/name-use DYNAMIC (CONF:4383-110)."
}, {
"id": "Patient.name.family",
"max": "1",
"min": 1,
"path": "Patient.name.family",
"short": "family",
"definition": "Such names SHALL contain exactly one [1..1] family (CONF:4383-60)."
}, {
"id": "Patient.name.given",
"max": "*",
"min": 1,
"path": "Patient.name.given",
"short": "given",
"definition": "Such names SHALL contain at least one [1..*] given (CONF:4383-61)."
}, {
"id": "Patient.telecom",
"max": "*",
"min": 0,
"path": "Patient.telecom",
"short": "telecom",
"definition": "SHOULD contain zero or more [0..*] telecom (CONF:4383-35)."
}, {
"id": "Patient.telecom.system",
"max": "1",
"min": 1,
"path": "Patient.telecom.system",
"short": "system",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"definition": "The telecom, if present, SHALL contain exactly one [1..1] system, which SHALL be selected from ValueSet Contact-point-system http://hl7.org/fhir/ValueSet/contact-point-system DYNAMIC (CONF:4383-42)."
}, {
"id": "Patient.telecom.value",
"max": "1",
"min": 1,
"path": "Patient.telecom.value",
"short": "value",
"definition": "The telecom, if present, SHALL contain exactly one [1..1] value (CONF:4383-43)."
}, {
"id": "Patient.telecom.use",
"max": "1",
"min": 1,
"path": "Patient.telecom.use",
"short": "use",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"definition": "The telecom, if present, SHALL contain exactly one [1..1] use, which SHALL be selected from ValueSet Contact-point-use http://hl7.org/fhir/ValueSet/contact-point-use DYNAMIC (CONF:4383-44)."
}, {
"id": "Patient.gender",
"max": "1",
"min": 1,
"path": "Patient.gender",
"type": [ {
"code": "code"
} ],
"short": "gender",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"definition": "SHALL contain exactly one [1..1] gender, which SHALL be selected from ValueSet Administrative-gender http://hl7.org/fhir/ValueSet/administrative-gender DYNAMIC (CONF:4383-55)."
}, {
"id": "Patient.birthDate",
"max": "1",
"min": 1,
"path": "Patient.birthDate",
"short": "birthDate",
"definition": "SHALL contain exactly one [1..1] birthDate (CONF:4383-56)."
}, {
"id": "Patient.address",
"max": "*",
"min": 0,
"path": "Patient.address",
"short": "address",
"definition": "SHOULD contain zero or more [0..*] address (CONF:4383-36)."
}, {
"id": "Patient.address.text",
"max": "1",
"min": 0,
"path": "Patient.address.text",
"short": "text",
"definition": "The address, if present, MAY contain zero or one [0..1] text (CONF:4383-111)."
}, {
"id": "Patient.address.line",
"max": "*",
"min": 0,
"path": "Patient.address.line",
"short": "line",
"definition": "The address, if present, SHOULD contain zero or more [0..*] line (CONF:4383-45)."
}, {
"id": "Patient.address.city",
"max": "1",
"min": 0,
"path": "Patient.address.city",
"short": "city",
"definition": "The address, if present, SHOULD contain zero or one [0..1] city (CONF:4383-46)."
}, {
"id": "Patient.address.state",
"max": "1",
"min": 0,
"path": "Patient.address.state",
"short": "state",
"definition": "The address, if present, SHOULD contain zero or one [0..1] state (CONF:4383-47)."
}, {
"id": "Patient.address.postalCode",
"max": "1",
"min": 0,
"path": "Patient.address.postalCode",
"short": "postalCode",
"definition": "The address, if present, SHOULD contain zero or one [0..1] postalCode (CONF:4383-48)."
}, {
"id": "Patient.address.country",
"max": "1",
"min": 1,
"path": "Patient.address.country",
"short": "country",
"definition": "The address, if present, SHALL contain exactly one [1..1] country, which SHALL be selected from CodeSystem ISO 3166 Part 1 Country Codes, 2nd Edition, Alpha-2 (urn:oid:1.0.3166.1.2.2) DYNAMIC (CONF:4383-49)."
}, {
"id": "Patient.communication",
"max": "1",
"min": 0,
"path": "Patient.communication",
"short": "communication",
"definition": "SHOULD contain zero or one [0..1] communication (CONF:4383-107)."
}, {
"id": "Patient.communication.language",
"max": "1",
"min": 1,
"path": "Patient.communication.language",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "language",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"definition": "The communication, if present, SHALL contain exactly one [1..1] language, which SHALL be selected from ValueSet Languages http://hl7.org/fhir/ValueSet/languages DYNAMIC (CONF:4383-108)."
}, {
"id": "Patient.communication.preferred",
"max": "1",
"min": 0,
"path": "Patient.communication.preferred",
"short": "preferred",
"definition": "The communication, if present, SHALL contain zero or one [0..1] preferred (CONF:4383-109)."
} ]
},
"contact": [ {
"name": "AbdulMalik Shakir",
"telecom": [ {
"use": "work",
"value": "6266444491",
"system": "phone"
}, {
"use": "work",
"value": "abdulmalik.shakir@hi3solutions.com",
"system": "email"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}