Common Data Models Harmonization, published by HL7 International - Biomedical Research and Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cdmh/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: CdmhPatient

Defining URL:	http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient
Version:	1.0.0
Name:	CdmhPatient
Title:	CDMH Patient
Status:	Draft as of 9/1/19
Definition:	This is the Patient Resource profile for the IG.
Publisher:	HL7 International - Biomedical Research and Regulation Work Group
Copyright:	Used by permission of HL7, all rights reserved Creative Commons License
Source Resource:	XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Patient.language	preferred	CommonLanguages Max Binding: AllLanguages
Patient.identifier.use	required	IdentifierUse
Patient.identifier.type	extensible	Identifier Type Codes
Patient.name.use	required	NameUse
Patient.telecom.system	required	ContactPointSystem
Patient.telecom.use	required	ContactPointUse
Patient.gender	required	AdministrativeGender
Patient.address.use	required	AddressUse
Patient.address.type	required	AddressType
Patient.address.state	extensible	UspsTwoLetterAlphabeticCodes
Patient.maritalStatus	extensible	Marital Status Codes
Patient.contact.relationship	extensible	PatientContactRelationship
Patient.contact.gender	required	AdministrativeGender
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.type	required	LinkType

Constraints

Id	Path	Details	Requirements
dom-2	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	Patient.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:race	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:race	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:ethnicity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:ethnicity	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:birthsex	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:birthsex	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:genderIdentity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:genderIdentity	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:sexualOrientation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:sexualOrientation	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:pcornet-race	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:pcornet-race	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:pcornet-ethnicity	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:pcornet-ethnicity	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:birthTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.extension:birthTime	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.active	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
us-core-8	Patient.name	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (family.exists() or given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
ele-1	Patient.name.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.name.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.name.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.family	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.given	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.prefix	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.suffix	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.name.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.telecom.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.telecom.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom.rank	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.telecom.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.birthDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.deceased[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.address.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.address.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.line	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.city	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.district	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.state	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.postalCode	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.country	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.address.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.maritalStatus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.multipleBirth[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.photo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
pat-1	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
ele-1	Patient.contact.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.contact.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact.relationship	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.telecom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.address	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.gender	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.contact.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.communication.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.communication.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.communication.preferred	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.generalPractitioner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.managingOrganization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.link.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.link.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Patient.link.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.link.other	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Patient.link.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())