Feb Test guide

This guide is for testing a link and learning link.

Column 1	Column 2	Column 3
1.1	name	comment for 1.1
2.1	name	comment for 2.1

StructureDefinition StructureDefinition guide for the test-patient resource in the test project. You can find the resource on https://simplifier.net/febtest/patientkkk. Notice that the path in the URL is exactly the same as the placeholder.

Differential

US Core Patient Profile (Patient)			Patient	Element id Patient:uscorepatient Short description US Core Patient Profile Alternate names SubjectOfCare Client Resident 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. Data type Patient Mappings cda: ClinicalDocument.recordTarget.patientRole rim: Patient[classCode=PAT] w5: administrative.individual argonaut-dq-dstu2: Patient
id	Σ	0..1	id	There are no (further) constraints on this element Element id Patient.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Data type id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Patient.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. Data type Meta
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Patient.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Data type uri
language		0..1	codeBinding	There are no (further) constraints on this element Element id Patient.language Short description Language of the resource content Definition The base language in which the resource is written. Data type code Binding A human language. ?? (required)
text	I	0..1	Narrative	There are no (further) constraints on this element Element id Patient.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. Data type Narrative Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Patient.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Data type Resource Mappings rim: N/A
extension		0..*	Extension	Element id Patient.extension Short description Additional Content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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. Data type Extension Sliced: Unordered, Open, by url(Value) Mappings rim: N/A
race	S I	0..1	Extension	Element id Patient:uscorepatient.extension:race Short description US Core Race Extension Alternate names extensions, user content Definition Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The race codes used to represent these concepts are based upon the CDC Race and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 921 reference race. The race concepts are grouped by and pre-mapped to the 5 OMB race categories: - American Indian or Alaska Native - Asian - Black or African American - Native Hawaiian or Other Pacific Islander - White. Data type Extension Extension URL http://hl7.org/fhir/us/core/StructureDefinition/us-core-race Constraints ele-1: All FHIR elements must have a @value or children `children().count() > id.count()` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A argonaut-dq-dstu2: Patient.extension
ethnicity	S I	0..1	Extension	Element id Patient:uscorepatient.extension:ethnicity Short description US Core ethnicity Extension Alternate names extensions, user content Definition Concepts classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality. The ethnicity codes used to represent these concepts are based upon the CDC ethnicity and Ethnicity Code Set Version 1.0 which includes over 900 concepts for representing race and ethnicity of which 43 reference ethnicity. The ethnicity concepts are grouped by and pre-mapped to the 2 OMB ethnicity categories: - Hispanic or Latino - Not Hispanic or Latino. Data type Extension Extension URL http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Constraints ele-1: All FHIR elements must have a @value or children `children().count() > id.count()` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A argonaut-dq-dstu2: Patient.extension
birthsex	S I	0..1	ExtensionBinding	Element id Patient:uscorepatient.extension:birthsex Short description Extension Alternate names extensions, user content Definition A code classifying the person's sex assigned at birth as specified by the Office of the National Coordinator for Health IT (ONC). Comments The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex. Data type Extension Extension URL http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding Code for sex assigned at birth ?? (required) Constraints ele-1: All FHIR elements must have a @value or children `children().count() > id.count()` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender iso11179: .patient.administrativeGenderCode argonaut-dq-dstu2: Patient.extension
modifierExtension	?!	0..*	Extension	There are no (further) constraints on this element Element id Patient.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content 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. Data type Extension Mappings rim: N/A
identifier	S Σ	1..*	Identifier	Element id Patient:uscorepatient.identifier Short description An identifier for this patient Definition An identifier for this patient. Requirements Patients are almost always assigned specific numerical identifiers. Data type Identifier Mappings cda: .id v2: PID-3 rim: id w5: id argonaut-dq-dstu2: Patient.identifier
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Data type boolean Default value true Mappings cda: n/a rim: statusCode w5: status
name	S Σ	1..*	HumanName	Element id Patient:uscorepatient.name Short description A name associated with the patient Definition A name associated with the individual. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. Data type HumanName Mappings cda: .patient.name v2: PID-5, PID-9 rim: name argonaut-dq-dstu2: Patient.name
telecom	Σ	0..*	ContactPoint	There are no (further) constraints on this element Element id Patient.telecom Short description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Mappings cda: .telecom v2: PID-13, PID-14, PID-40 rim: telecom
gender	S Σ	1..1	codeBinding	Element id Patient:uscorepatient.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Mappings cda: .patient.administrativeGenderCode v2: PID-8 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender argonaut-dq-dstu2: Patient.gender
birthDate	S Σ	0..1	date	Element id Patient:uscorepatient.birthDate Short description The date of birth for the individual Definition The date of birth for the individual. Requirements Age of the individual drives many clinical processes. Data type date Mappings loinc: 21112-8 cda: .patient.birthTime v2: PID-7 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime argonaut-dq-dstu2: Patient.birthDate
deceased[x]	Σ ?!	0..1		There are no (further) constraints on this element Element id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. 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. Mappings cda: n/a v2: PID-30 (bool) and PID-29 (datetime) rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime
deceasedBoolean			boolean	There are no (further) constraints on this element Data type boolean
deceasedDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
address	Σ	0..*	Address	There are no (further) constraints on this element Element id Patient.address Short description Addresses for the individual Definition Addresses for the individual. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Data type Address Mappings cda: .addr v2: PID-11 rim: addr
maritalStatus		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Patient.maritalStatus Short description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status. Requirements Most, if not all systems capture it. Data type CodeableConcept Binding The domestic partnership status of a person. Marital Status Codes (required) Mappings cda: .patient.maritalStatusCode v2: PID-16 rim: player[classCode=PSN]/maritalStatusCode
multipleBirth[x]		0..1		There are no (further) constraints on this element Element id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple or indicates the actual birth order. Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Mappings cda: n/a v2: PID-24 (bool), PID-25 (integer) rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
multipleBirthBoolean			boolean	There are no (further) constraints on this element Data type boolean
multipleBirthInteger			integer	There are no (further) constraints on this element Data type integer
photo		0..*	Attachment	There are no (further) constraints on this element Element id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Data type Attachment Mappings cda: n/a v2: OBX-5 - needs a profile rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/desc
contact	I	0..*	BackboneElement	There are no (further) constraints on this element Element id Patient.contact Short description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. Data type BackboneElement Constraints pat-1: SHALL at least contain a contact's details or a reference to an organization Mappings cda: n/a rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id		0..1	id	There are no (further) constraints on this element Element id Patient.contact.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). Data type id Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id Patient.contact.extension Short description Additional Content defined by implementations Alternate names extensions, user content 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. Data type Extension Mappings rim: n/a
modifierExtension	?!	0..*	Extension	There are no (further) constraints on this element Element id Patient.contact.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content, modifiers 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. Data type Extension Mappings rim: N/A
relationship		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. Data type CodeableConcept Binding The nature of the relationship between a patient and a contact person for that patient. ?? (extensible) Mappings cda: n/a v2: NK1-7, NK1-3 rim: code
name		0..1	HumanName	There are no (further) constraints on this element Element id Patient.contact.name Short description A name associated with the contact person Definition A name associated with the contact person. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Data type HumanName Mappings cda: n/a v2: NK1-2 rim: name
telecom		0..*	ContactPoint	There are no (further) constraints on this element Element id Patient.contact.telecom Short description A contact detail for the person Definition A contact detail for the person, e.g. a telephone number or an email address. Requirements People have (primary) ways to contact them in some way such as phone, email. Data type ContactPoint Mappings cda: n/a v2: NK1-5, NK1-6, NK1-40 rim: telecom
address		0..1	Address	There are no (further) constraints on this element Element id Patient.contact.address Short description Address for the contact person Definition Address for the contact person. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Data type Address Mappings cda: n/a v2: NK1-4 rim: addr
gender		0..1	codeBinding	There are no (further) constraints on this element Element id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Data type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Mappings cda: n/a v2: NK1-15 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender
organization	I	0..1	Organization()	There are no (further) constraints on this element Element id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. Data type Organization() Mappings cda: n/a v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim: scoper
period		0..1	Period	There are no (further) constraints on this element Element id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. Data type Period Mappings cda: n/a rim: effectiveTime
animal	Σ	0..0	BackboneElement	Element id Patient:uscorepatient.animal Short description This patient is known to be an animal (non-human) Definition This patient is known to be an animal. Requirements Many clinical systems are extended to care for animal patients as well as human. Data type BackboneElement Mappings cda: n/a rim: player[classCode=ANM] argonaut-dq-dstu2: Patient.animal
communication	S	0..*	BackboneElement	Element id Patient:uscorepatient.communication Short description A list of Languages which may be used to communicate with the patient about his or her health Definition Languages which may be used to communicate with the patient about his or her health. 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. Data type BackboneElement Mappings cda: patient.languageCommunication rim: LanguageCommunication argonaut-dq-dstu2: Patient.communication
id		0..1	id	There are no (further) constraints on this element Element id Patient.communication.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). Data type id Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id Patient.communication.extension Short description Additional Content defined by implementations Alternate names extensions, user content 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. Data type Extension Mappings rim: n/a
modifierExtension	?!	0..*	Extension	There are no (further) constraints on this element Element id Patient.communication.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content, modifiers 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. Data type Extension Mappings rim: N/A
language	S	1..1	CodeableConceptBinding	Element id Patient:uscorepatient.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Data type CodeableConcept Binding A human language. ?? (extensible) Mappings cda: .languageCode v2: PID-15, LAN-2 rim: player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code argonaut-dq-dstu2: Patient.communication.language
preferred		0..1	boolean	There are no (further) constraints on this element Element id Patient.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Data type boolean Mappings cda: .preferenceInd v2: PID-15 rim: preferenceInd
careProvider		0..*	Organization( \| )	There are no (further) constraints on this element Element id Patient.careProvider Short description Patient's nominated primary care provider Definition Patient's nominated care provider. Data type Organization( \| ) Mappings cda: n/a v2: PD1-4 rim: subjectOf.CareEvent.performer.AssignedEntity
managingOrganization	Σ	0..1	Organization()	There are no (further) constraints on this element Element id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Data type Organization() Mappings cda: .providerOrganization rim: scoper
link	?!	0..*	BackboneElement	There are no (further) constraints on this element Element id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers. Data type BackboneElement Mappings cda: n/a rim: outboundLink
id		0..1	id	There are no (further) constraints on this element Element id Patient.link.id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references). Data type id Mappings rim: n/a
extension		0..*	Extension	There are no (further) constraints on this element Element id Patient.link.extension Short description Additional Content defined by implementations Alternate names extensions, user content 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. Data type Extension Mappings rim: n/a
modifierExtension	?!	0..*	Extension	There are no (further) constraints on this element Element id Patient.link.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content, modifiers 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. Data type Extension Mappings rim: N/A
other	?!	1..1	Patient()	There are no (further) constraints on this element Element id Patient.link.other Short description The other patient resource that the link refers to Definition The other patient resource that the link refers to. Data type Patient() Mappings cda: n/a v2: PID-3, MRG-1 rim: id
type	?!	1..1	codeBinding	There are no (further) constraints on this element Element id Patient.link.type Short description replace \| refer \| seealso - type of link Definition The type of link between this patient resource and another patient resource. Data type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Mappings cda: n/a rim: typeCode